All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.keycloak.openid.inputs.UserRealmRoleProtocolMapperState Maven / Gradle / Ivy

There is a newer version: 5.4.0
Show newest version
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.keycloak.openid.inputs;

import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.Boolean;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class UserRealmRoleProtocolMapperState extends com.pulumi.resources.ResourceArgs {

    public static final UserRealmRoleProtocolMapperState Empty = new UserRealmRoleProtocolMapperState();

    /**
     * Indicates if the attribute should be a claim in the access token.
     * 
     */
    @Import(name="addToAccessToken")
    private @Nullable Output addToAccessToken;

    /**
     * @return Indicates if the attribute should be a claim in the access token.
     * 
     */
    public Optional> addToAccessToken() {
        return Optional.ofNullable(this.addToAccessToken);
    }

    /**
     * Indicates if the attribute should be a claim in the id token.
     * 
     */
    @Import(name="addToIdToken")
    private @Nullable Output addToIdToken;

    /**
     * @return Indicates if the attribute should be a claim in the id token.
     * 
     */
    public Optional> addToIdToken() {
        return Optional.ofNullable(this.addToIdToken);
    }

    /**
     * Indicates if the attribute should appear in the userinfo response body.
     * 
     */
    @Import(name="addToUserinfo")
    private @Nullable Output addToUserinfo;

    /**
     * @return Indicates if the attribute should appear in the userinfo response body.
     * 
     */
    public Optional> addToUserinfo() {
        return Optional.ofNullable(this.addToUserinfo);
    }

    @Import(name="claimName")
    private @Nullable Output claimName;

    public Optional> claimName() {
        return Optional.ofNullable(this.claimName);
    }

    /**
     * Claim type used when serializing tokens.
     * 
     */
    @Import(name="claimValueType")
    private @Nullable Output claimValueType;

    /**
     * @return Claim type used when serializing tokens.
     * 
     */
    public Optional> claimValueType() {
        return Optional.ofNullable(this.claimValueType);
    }

    /**
     * The mapper's associated client. Cannot be used at the same time as client_scope_id.
     * 
     */
    @Import(name="clientId")
    private @Nullable Output clientId;

    /**
     * @return The mapper's associated client. Cannot be used at the same time as client_scope_id.
     * 
     */
    public Optional> clientId() {
        return Optional.ofNullable(this.clientId);
    }

    /**
     * The mapper's associated client scope. Cannot be used at the same time as client_id.
     * 
     */
    @Import(name="clientScopeId")
    private @Nullable Output clientScopeId;

    /**
     * @return The mapper's associated client scope. Cannot be used at the same time as client_id.
     * 
     */
    public Optional> clientScopeId() {
        return Optional.ofNullable(this.clientScopeId);
    }

    /**
     * Indicates whether this attribute is a single value or an array of values.
     * 
     */
    @Import(name="multivalued")
    private @Nullable Output multivalued;

    /**
     * @return Indicates whether this attribute is a single value or an array of values.
     * 
     */
    public Optional> multivalued() {
        return Optional.ofNullable(this.multivalued);
    }

    /**
     * A human-friendly name that will appear in the Keycloak console.
     * 
     */
    @Import(name="name")
    private @Nullable Output name;

    /**
     * @return A human-friendly name that will appear in the Keycloak console.
     * 
     */
    public Optional> name() {
        return Optional.ofNullable(this.name);
    }

    /**
     * The realm id where the associated client or client scope exists.
     * 
     */
    @Import(name="realmId")
    private @Nullable Output realmId;

    /**
     * @return The realm id where the associated client or client scope exists.
     * 
     */
    public Optional> realmId() {
        return Optional.ofNullable(this.realmId);
    }

    /**
     * Prefix that will be added to each realm role.
     * 
     */
    @Import(name="realmRolePrefix")
    private @Nullable Output realmRolePrefix;

    /**
     * @return Prefix that will be added to each realm role.
     * 
     */
    public Optional> realmRolePrefix() {
        return Optional.ofNullable(this.realmRolePrefix);
    }

    private UserRealmRoleProtocolMapperState() {}

    private UserRealmRoleProtocolMapperState(UserRealmRoleProtocolMapperState $) {
        this.addToAccessToken = $.addToAccessToken;
        this.addToIdToken = $.addToIdToken;
        this.addToUserinfo = $.addToUserinfo;
        this.claimName = $.claimName;
        this.claimValueType = $.claimValueType;
        this.clientId = $.clientId;
        this.clientScopeId = $.clientScopeId;
        this.multivalued = $.multivalued;
        this.name = $.name;
        this.realmId = $.realmId;
        this.realmRolePrefix = $.realmRolePrefix;
    }

    public static Builder builder() {
        return new Builder();
    }
    public static Builder builder(UserRealmRoleProtocolMapperState defaults) {
        return new Builder(defaults);
    }

    public static final class Builder {
        private UserRealmRoleProtocolMapperState $;

        public Builder() {
            $ = new UserRealmRoleProtocolMapperState();
        }

        public Builder(UserRealmRoleProtocolMapperState defaults) {
            $ = new UserRealmRoleProtocolMapperState(Objects.requireNonNull(defaults));
        }

        /**
         * @param addToAccessToken Indicates if the attribute should be a claim in the access token.
         * 
         * @return builder
         * 
         */
        public Builder addToAccessToken(@Nullable Output addToAccessToken) {
            $.addToAccessToken = addToAccessToken;
            return this;
        }

        /**
         * @param addToAccessToken Indicates if the attribute should be a claim in the access token.
         * 
         * @return builder
         * 
         */
        public Builder addToAccessToken(Boolean addToAccessToken) {
            return addToAccessToken(Output.of(addToAccessToken));
        }

        /**
         * @param addToIdToken Indicates if the attribute should be a claim in the id token.
         * 
         * @return builder
         * 
         */
        public Builder addToIdToken(@Nullable Output addToIdToken) {
            $.addToIdToken = addToIdToken;
            return this;
        }

        /**
         * @param addToIdToken Indicates if the attribute should be a claim in the id token.
         * 
         * @return builder
         * 
         */
        public Builder addToIdToken(Boolean addToIdToken) {
            return addToIdToken(Output.of(addToIdToken));
        }

        /**
         * @param addToUserinfo Indicates if the attribute should appear in the userinfo response body.
         * 
         * @return builder
         * 
         */
        public Builder addToUserinfo(@Nullable Output addToUserinfo) {
            $.addToUserinfo = addToUserinfo;
            return this;
        }

        /**
         * @param addToUserinfo Indicates if the attribute should appear in the userinfo response body.
         * 
         * @return builder
         * 
         */
        public Builder addToUserinfo(Boolean addToUserinfo) {
            return addToUserinfo(Output.of(addToUserinfo));
        }

        public Builder claimName(@Nullable Output claimName) {
            $.claimName = claimName;
            return this;
        }

        public Builder claimName(String claimName) {
            return claimName(Output.of(claimName));
        }

        /**
         * @param claimValueType Claim type used when serializing tokens.
         * 
         * @return builder
         * 
         */
        public Builder claimValueType(@Nullable Output claimValueType) {
            $.claimValueType = claimValueType;
            return this;
        }

        /**
         * @param claimValueType Claim type used when serializing tokens.
         * 
         * @return builder
         * 
         */
        public Builder claimValueType(String claimValueType) {
            return claimValueType(Output.of(claimValueType));
        }

        /**
         * @param clientId The mapper's associated client. Cannot be used at the same time as client_scope_id.
         * 
         * @return builder
         * 
         */
        public Builder clientId(@Nullable Output clientId) {
            $.clientId = clientId;
            return this;
        }

        /**
         * @param clientId The mapper's associated client. Cannot be used at the same time as client_scope_id.
         * 
         * @return builder
         * 
         */
        public Builder clientId(String clientId) {
            return clientId(Output.of(clientId));
        }

        /**
         * @param clientScopeId The mapper's associated client scope. Cannot be used at the same time as client_id.
         * 
         * @return builder
         * 
         */
        public Builder clientScopeId(@Nullable Output clientScopeId) {
            $.clientScopeId = clientScopeId;
            return this;
        }

        /**
         * @param clientScopeId The mapper's associated client scope. Cannot be used at the same time as client_id.
         * 
         * @return builder
         * 
         */
        public Builder clientScopeId(String clientScopeId) {
            return clientScopeId(Output.of(clientScopeId));
        }

        /**
         * @param multivalued Indicates whether this attribute is a single value or an array of values.
         * 
         * @return builder
         * 
         */
        public Builder multivalued(@Nullable Output multivalued) {
            $.multivalued = multivalued;
            return this;
        }

        /**
         * @param multivalued Indicates whether this attribute is a single value or an array of values.
         * 
         * @return builder
         * 
         */
        public Builder multivalued(Boolean multivalued) {
            return multivalued(Output.of(multivalued));
        }

        /**
         * @param name A human-friendly name that will appear in the Keycloak console.
         * 
         * @return builder
         * 
         */
        public Builder name(@Nullable Output name) {
            $.name = name;
            return this;
        }

        /**
         * @param name A human-friendly name that will appear in the Keycloak console.
         * 
         * @return builder
         * 
         */
        public Builder name(String name) {
            return name(Output.of(name));
        }

        /**
         * @param realmId The realm id where the associated client or client scope exists.
         * 
         * @return builder
         * 
         */
        public Builder realmId(@Nullable Output realmId) {
            $.realmId = realmId;
            return this;
        }

        /**
         * @param realmId The realm id where the associated client or client scope exists.
         * 
         * @return builder
         * 
         */
        public Builder realmId(String realmId) {
            return realmId(Output.of(realmId));
        }

        /**
         * @param realmRolePrefix Prefix that will be added to each realm role.
         * 
         * @return builder
         * 
         */
        public Builder realmRolePrefix(@Nullable Output realmRolePrefix) {
            $.realmRolePrefix = realmRolePrefix;
            return this;
        }

        /**
         * @param realmRolePrefix Prefix that will be added to each realm role.
         * 
         * @return builder
         * 
         */
        public Builder realmRolePrefix(String realmRolePrefix) {
            return realmRolePrefix(Output.of(realmRolePrefix));
        }

        public UserRealmRoleProtocolMapperState build() {
            return $;
        }
    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy