UserSessionNoteProtocolMapper

Create a UserSessionNoteProtocolMapper Resource

new UserSessionNoteProtocolMapper(name: string, args: UserSessionNoteProtocolMapperArgs, opts?: CustomResourceOptions);

def UserSessionNoteProtocolMapper(resource_name, opts=None, add_to_access_token=None, add_to_id_token=None, claim_name=None, claim_value_type=None, client_id=None, client_scope_id=None, name=None, realm_id=None, session_note_label=None, __props__=None);

func NewUserSessionNoteProtocolMapper(ctx *Context, name string, args UserSessionNoteProtocolMapperArgs, opts ...ResourceOption) (*UserSessionNoteProtocolMapper, error)

public UserSessionNoteProtocolMapper(string name, UserSessionNoteProtocolMapperArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args UserSessionNoteProtocolMapperArgs: 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 UserSessionNoteProtocolMapperArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

UserSessionNoteProtocolMapper Resource Properties

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

Inputs

The UserSessionNoteProtocolMapper 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.
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.
ClientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
Name string: A human-friendly name that will appear in the Keycloak console.
SessionNoteLabel string: String value being the name of stored user session note within the UserSessionModel.note map.

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.
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.
ClientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
Name string: A human-friendly name that will appear in the Keycloak console.
SessionNoteLabel string: String value being the name of stored user session note within the UserSessionModel.note map.

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.
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.
clientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
name string: A human-friendly name that will appear in the Keycloak console.
sessionNoteLabel string: String value being the name of stored user session note within the UserSessionModel.note map.

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.
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_scope_id str: The mapper’s associated client scope. Cannot be used at the same time as client_id.
name str: A human-friendly name that will appear in the Keycloak console.
session_note_label str: String value being the name of stored user session note within the UserSessionModel.note map.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserSessionNoteProtocolMapper 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 UserSessionNoteProtocolMapper Resource

Get an existing UserSessionNoteProtocolMapper 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?: UserSessionNoteProtocolMapperState, opts?: CustomResourceOptions): UserSessionNoteProtocolMapper

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

func GetUserSessionNoteProtocolMapper(ctx *Context, name string, id IDInput, state *UserSessionNoteProtocolMapperState, opts ...ResourceOption) (*UserSessionNoteProtocolMapper, error)

public static UserSessionNoteProtocolMapper Get(string name, Input<string> id, UserSessionNoteProtocolMapperState? 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.
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.
ClientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
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.
SessionNoteLabel string: String value being the name of stored user session note within the UserSessionModel.note map.

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.
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.
ClientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
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.
SessionNoteLabel string: String value being the name of stored user session note within the UserSessionModel.note map.

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.
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.
clientScopeId string: The mapper’s associated client scope. Cannot be used at the same time as client_id.
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.
sessionNoteLabel string: String value being the name of stored user session note within the UserSessionModel.note map.

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.
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_scope_id str: The mapper’s associated client scope. Cannot be used at the same time as client_id.
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.
session_note_label str: String value being the name of stored user session note within the UserSessionModel.note map.

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