UserClientRoleProtocolMapper

Create a UserClientRoleProtocolMapper Resource

new UserClientRoleProtocolMapper(name: string, args: UserClientRoleProtocolMapperArgs, opts?: CustomResourceOptions);

def UserClientRoleProtocolMapper(resource_name, opts=None, add_to_access_token=None, add_to_id_token=None, add_to_userinfo=None, claim_name=None, claim_value_type=None, client_id=None, client_id_for_role_mappings=None, client_role_prefix=None, client_scope_id=None, multivalued=None, name=None, realm_id=None, __props__=None);

func NewUserClientRoleProtocolMapper(ctx *Context, name string, args UserClientRoleProtocolMapperArgs, opts ...ResourceOption) (*UserClientRoleProtocolMapper, error)

public UserClientRoleProtocolMapper(string name, UserClientRoleProtocolMapperArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args UserClientRoleProtocolMapperArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args UserClientRoleProtocolMapperArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args UserClientRoleProtocolMapperArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

UserClientRoleProtocolMapper Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The UserClientRoleProtocolMapper resource accepts the following input properties:

ClaimName string
RealmId string: The realm id where the associated client or client scope exists.
AddToAccessToken bool: Indicates if the attribute should be a claim in the access token.
AddToIdToken bool: Indicates if the attribute should be a claim in the id token.
AddToUserinfo bool: Indicates if the attribute should appear in the userinfo response body.
ClaimValueType string: Claim type used when serializing tokens.
ClientId string: The mapper’s associated client. Cannot be used at the same time as client_scope_id.
ClientIdForRoleMappings string: Client ID for role mappings.
ClientRolePrefix string: Prefix that will be added to each client role.
ClientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
Multivalued bool: Indicates whether this attribute is a single value or an array of values.
Name string: A human-friendly name that will appear in the Keycloak console.

ClaimName string
RealmId string: The realm id where the associated client or client scope exists.
AddToAccessToken bool: Indicates if the attribute should be a claim in the access token.
AddToIdToken bool: Indicates if the attribute should be a claim in the id token.
AddToUserinfo bool: Indicates if the attribute should appear in the userinfo response body.
ClaimValueType string: Claim type used when serializing tokens.
ClientId string: The mapper’s associated client. Cannot be used at the same time as client_scope_id.
ClientIdForRoleMappings string: Client ID for role mappings.
ClientRolePrefix string: Prefix that will be added to each client role.
ClientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
Multivalued bool: Indicates whether this attribute is a single value or an array of values.
Name string: A human-friendly name that will appear in the Keycloak console.

claimName string
realmId string: The realm id where the associated client or client scope exists.
addToAccessToken boolean: Indicates if the attribute should be a claim in the access token.
addToIdToken boolean: Indicates if the attribute should be a claim in the id token.
addToUserinfo boolean: Indicates if the attribute should appear in the userinfo response body.
claimValueType string: Claim type used when serializing tokens.
clientId string: The mapper’s associated client. Cannot be used at the same time as client_scope_id.
clientIdForRoleMappings string: Client ID for role mappings.
clientRolePrefix string: Prefix that will be added to each client role.
clientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
multivalued boolean: Indicates whether this attribute is a single value or an array of values.
name string: A human-friendly name that will appear in the Keycloak console.

claim_name str
realm_id str: The realm id where the associated client or client scope exists.
add_to_access_token bool: Indicates if the attribute should be a claim in the access token.
add_to_id_token bool: Indicates if the attribute should be a claim in the id token.
add_to_userinfo bool: Indicates if the attribute should appear in the userinfo response body.
claim_value_type str: Claim type used when serializing tokens.
client_id str: The mapper’s associated client. Cannot be used at the same time as client_scope_id.
client_id_for_role_mappings str: Client ID for role mappings.
client_role_prefix str: Prefix that will be added to each client role.
client_scope_id str: The mapper’s associated client scope. Cannot be used at the same time as client_id.
multivalued bool: Indicates whether this attribute is a single value or an array of values.
name str: A human-friendly name that will appear in the Keycloak console.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserClientRoleProtocolMapper resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing UserClientRoleProtocolMapper Resource

Get an existing UserClientRoleProtocolMapper resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserClientRoleProtocolMapperState, opts?: CustomResourceOptions): UserClientRoleProtocolMapper

static get(resource_name, id, opts=None, add_to_access_token=None, add_to_id_token=None, add_to_userinfo=None, claim_name=None, claim_value_type=None, client_id=None, client_id_for_role_mappings=None, client_role_prefix=None, client_scope_id=None, multivalued=None, name=None, realm_id=None, __props__=None);

func GetUserClientRoleProtocolMapper(ctx *Context, name string, id IDInput, state *UserClientRoleProtocolMapperState, opts ...ResourceOption) (*UserClientRoleProtocolMapper, error)

public static UserClientRoleProtocolMapper Get(string name, Input<string> id, UserClientRoleProtocolMapperState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AddToAccessToken bool: Indicates if the attribute should be a claim in the access token.
AddToIdToken bool: Indicates if the attribute should be a claim in the id token.
AddToUserinfo bool: Indicates if the attribute should appear in the userinfo response body.
ClaimName string
ClaimValueType string: Claim type used when serializing tokens.
ClientId string: The mapper’s associated client. Cannot be used at the same time as client_scope_id.
ClientIdForRoleMappings string: Client ID for role mappings.
ClientRolePrefix string: Prefix that will be added to each client role.
ClientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
Multivalued bool: Indicates whether this attribute is a single value or an array of values.
Name string: A human-friendly name that will appear in the Keycloak console.
RealmId string: The realm id where the associated client or client scope exists.

AddToAccessToken bool: Indicates if the attribute should be a claim in the access token.
AddToIdToken bool: Indicates if the attribute should be a claim in the id token.
AddToUserinfo bool: Indicates if the attribute should appear in the userinfo response body.
ClaimName string
ClaimValueType string: Claim type used when serializing tokens.
ClientId string: The mapper’s associated client. Cannot be used at the same time as client_scope_id.
ClientIdForRoleMappings string: Client ID for role mappings.
ClientRolePrefix string: Prefix that will be added to each client role.
ClientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
Multivalued bool: Indicates whether this attribute is a single value or an array of values.
Name string: A human-friendly name that will appear in the Keycloak console.
RealmId string: The realm id where the associated client or client scope exists.

addToAccessToken boolean: Indicates if the attribute should be a claim in the access token.
addToIdToken boolean: Indicates if the attribute should be a claim in the id token.
addToUserinfo boolean: Indicates if the attribute should appear in the userinfo response body.
claimName string
claimValueType string: Claim type used when serializing tokens.
clientId string: The mapper’s associated client. Cannot be used at the same time as client_scope_id.
clientIdForRoleMappings string: Client ID for role mappings.
clientRolePrefix string: Prefix that will be added to each client role.
clientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
multivalued boolean: Indicates whether this attribute is a single value or an array of values.
name string: A human-friendly name that will appear in the Keycloak console.
realmId string: The realm id where the associated client or client scope exists.

add_to_access_token bool: Indicates if the attribute should be a claim in the access token.
add_to_id_token bool: Indicates if the attribute should be a claim in the id token.
add_to_userinfo bool: Indicates if the attribute should appear in the userinfo response body.
claim_name str
claim_value_type str: Claim type used when serializing tokens.
client_id str: The mapper’s associated client. Cannot be used at the same time as client_scope_id.
client_id_for_role_mappings str: Client ID for role mappings.
client_role_prefix str: Prefix that will be added to each client role.
client_scope_id str: The mapper’s associated client scope. Cannot be used at the same time as client_id.
multivalued bool: Indicates whether this attribute is a single value or an array of values.
name str: A human-friendly name that will appear in the Keycloak console.
realm_id str: The realm id where the associated client or client scope exists.

Package Details

Repository: https://github.com/pulumi/pulumi-keycloak
License: Apache-2.0
Notes: This Pulumi package is based on the keycloak Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud