Package-level declarations
Types
Allows for creating and managing audience protocol mappers within Keycloak. Audience protocol mappers allow you to add audiences to the aud claim within issued tokens. The audience can be a custom string, or it can be mapped to the ID of a pre-existing client.
Allows for creating and managing audience protocol mappers within Keycloak. Audience protocol mappers allow you to add audiences to the aud claim within issued tokens. The audience can be a custom string, or it can be mapped to the ID of a pre-existing client.
Builder for AudienceProtocolMapperArgs.
Builder for AudienceProtocolMapper.
Allows for creating the "Audience Resolve" OIDC protocol mapper within Keycloak. This protocol mapper is useful to avoid manual management of audiences, instead relying on the presence of client roles to imply which audiences are appropriate for the token. See the Keycloak docs for more details.
Allows for creating the "Audience Resolve" OIDC protocol mapper within Keycloak. This protocol mapper is useful to avoid manual management of audiences, instead relying on the presence of client roles to imply which audiences are appropriate for the token. See the Keycloak docs for more details.
Builder for AudienceResolveProtocolMapperArgs.
Builder for AudienceResolveProtocolMapper.
Allows for creating and managing Keycloak clients that use the OpenID Connect protocol. Clients are entities that can use Keycloak for user authentication. Typically, clients are applications that redirect users to Keycloak for authentication in order to take advantage of Keycloak's user sessions for SSO.
Builder for ClientAggregatePolicyArgs.
Builder for ClientAggregatePolicy.
Allows for creating and managing Keycloak clients that use the OpenID Connect protocol. Clients are entities that can use Keycloak for user authentication. Typically, clients are applications that redirect users to Keycloak for authentication in order to take advantage of Keycloak's user sessions for SSO.
Builder for ClientArgs.
Allows you to manage openid Client Authorization Client Scope type Policies.
Allows you to manage openid Client Authorization Client Scope type Policies.
Allows you to manage openid Client Authorization Permissions.
Allows you to manage openid Client Authorization Permissions.
Builder for ClientAuthorizationPermissionArgs.
Builder for ClientAuthorizationPermission.
Builder for ClientAuthorizationResourceArgs.
Builder for ClientAuthorizationResource.
Builder for ClientAuthorizationScopeArgs.
Builder for ClientAuthorizationScope.
Builder for ClientDefaultScopesArgs.
Builder for ClientDefaultScopes.
Builder for ClientGroupPolicyArgs.
Builder for ClientGroupPolicy.
Builder for ClientJsPolicyArgs.
Builder for ClientJsPolicy.
Builder for ClientOptionalScopesArgs.
Builder for ClientOptionalScopes.
Allows you to manage all openid client Scope Based Permissions. This is part of a preview keycloak feature. You need to enable this feature to be able to use this resource. More information about enabling the preview feature can be found here: https://www.keycloak.org/securing-apps/token-exchange When enabling Openid Client Permissions, Keycloak does several things automatically:
Allows you to manage all openid client Scope Based Permissions. This is part of a preview keycloak feature. You need to enable this feature to be able to use this resource. More information about enabling the preview feature can be found here: https://www.keycloak.org/securing-apps/token-exchange When enabling Openid Client Permissions, Keycloak does several things automatically:
Builder for ClientPermissionsArgs.
Builder for ClientPermissions.
This resource can be used to create client policy.
This resource can be used to create client policy.
Builder for ClientPolicyArgs.
Builder for ClientPolicy.
Builder for Client.
Builder for ClientRolePolicyArgs.
Builder for ClientRolePolicy.
Allows for creating and managing Keycloak client scopes that can be attached to clients that use the OpenID Connect protocol. Client Scopes can be used to share common protocol and role mappings between multiple clients within a realm. They can also be used by clients to conditionally request claims or roles for a user based on the OAuth 2.0 scope parameter.
Allows for creating and managing Keycloak client scopes that can be attached to clients that use the OpenID Connect protocol. Client Scopes can be used to share common protocol and role mappings between multiple clients within a realm. They can also be used by clients to conditionally request claims or roles for a user based on the OAuth 2.0 scope parameter.
Builder for ClientScopeArgs.
Builder for ClientScope.
Allows for assigning realm roles to the service account of an openid client. You need to set service_accounts_enabled to true for the openid client that should be assigned the role. If you'd like to attach client roles to a service account, please use the keycloak.openid.ClientServiceAccountRole resource.
Allows for assigning realm roles to the service account of an openid client. You need to set service_accounts_enabled to true for the openid client that should be assigned the role. If you'd like to attach client roles to a service account, please use the keycloak.openid.ClientServiceAccountRole resource.
Builder for ClientServiceAccountRealmRoleArgs.
Builder for ClientServiceAccountRealmRole.
Allows for assigning client roles to the service account of an openid client. You need to set service_accounts_enabled to true for the openid client that should be assigned the role. If you'd like to attach realm roles to a service account, please use the keycloak.openid.ClientServiceAccountRealmRole resource.
Allows for assigning client roles to the service account of an openid client. You need to set service_accounts_enabled to true for the openid client that should be assigned the role. If you'd like to attach realm roles to a service account, please use the keycloak.openid.ClientServiceAccountRealmRole resource.
Builder for ClientServiceAccountRoleArgs.
Builder for ClientServiceAccountRole.
Builder for ClientTimePolicyArgs.
Builder for ClientTimePolicy.
Builder for ClientUserPolicyArgs.
Builder for ClientUserPolicy.
Allows for creating and managing full name protocol mappers within Keycloak. Full name protocol mappers allow you to map a user's first and last name to the OpenID Connect name claim in a token. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Allows for creating and managing full name protocol mappers within Keycloak. Full name protocol mappers allow you to map a user's first and last name to the OpenID Connect name claim in a token. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Builder for FullNameProtocolMapperArgs.
Builder for FullNameProtocolMapper.
Allows for creating and managing group membership protocol mappers within Keycloak. Group membership protocol mappers allow you to map a user's group memberships to a claim in a token. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Allows for creating and managing group membership protocol mappers within Keycloak. Group membership protocol mappers allow you to map a user's group memberships to a claim in a token. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Builder for GroupMembershipProtocolMapperArgs.
Builder for GroupMembershipProtocolMapper.
Allows for creating and managing hardcoded claim protocol mappers within Keycloak. Hardcoded claim protocol mappers allow you to define a claim with a hardcoded value. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Allows for creating and managing hardcoded claim protocol mappers within Keycloak. Hardcoded claim protocol mappers allow you to define a claim with a hardcoded value. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Builder for HardcodedClaimProtocolMapperArgs.
Builder for HardcodedClaimProtocolMapper.
Allows for creating and managing hardcoded role protocol mappers within Keycloak. Hardcoded role protocol mappers allow you to specify a single role to always map to an access token for a client. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Allows for creating and managing hardcoded role protocol mappers within Keycloak. Hardcoded role protocol mappers allow you to specify a single role to always map to an access token for a client. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Builder for HardcodedRoleProtocolMapperArgs.
Builder for HardcodedRoleProtocolMapper.
Allows for creating and managing script protocol mappers within Keycloak. Script protocol mappers evaluate a JavaScript function to produce a token claim based on context information. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Allows for creating and managing script protocol mappers within Keycloak. Script protocol mappers evaluate a JavaScript function to produce a token claim based on context information. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Builder for ScriptProtocolMapperArgs.
Builder for ScriptProtocolMapper.
Allows for creating and managing user attribute protocol mappers within Keycloak. User attribute protocol mappers allow you to map custom attributes defined for a user within Keycloak to a claim in a token. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Allows for creating and managing user attribute protocol mappers within Keycloak. User attribute protocol mappers allow you to map custom attributes defined for a user within Keycloak to a claim in a token. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Builder for UserAttributeProtocolMapperArgs.
Builder for UserAttributeProtocolMapper.
Allows for creating and managing user client role protocol mappers within Keycloak. User client role protocol mappers allow you to define a claim containing the list of a client roles. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Allows for creating and managing user client role protocol mappers within Keycloak. User client role protocol mappers allow you to define a claim containing the list of a client roles. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Builder for UserClientRoleProtocolMapperArgs.
Builder for UserClientRoleProtocolMapper.
Allows for creating and managing user property protocol mappers within Keycloak. User property protocol mappers allow you to map built in properties defined on the Keycloak user interface to a claim in a token. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Allows for creating and managing user property protocol mappers within Keycloak. User property protocol mappers allow you to map built in properties defined on the Keycloak user interface to a claim in a token. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Builder for UserPropertyProtocolMapperArgs.
Builder for UserPropertyProtocolMapper.
Allows for creating and managing user realm role protocol mappers within Keycloak. User realm role protocol mappers allow you to define a claim containing the list of the realm roles. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Allows for creating and managing user realm role protocol mappers within Keycloak. User realm role protocol mappers allow you to define a claim containing the list of the realm roles. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Builder for UserRealmRoleProtocolMapperArgs.
Builder for UserRealmRoleProtocolMapper.
Allows for creating and managing user session note protocol mappers within Keycloak. User session note protocol mappers map a custom user session note to a token claim. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Allows for creating and managing user session note protocol mappers within Keycloak. User session note protocol mappers map a custom user session note to a token claim. Protocol mappers can be defined for a single client, or they can be defined for a client scope which can be shared between multiple different clients.
Builder for UserSessionNoteProtocolMapperArgs.
Builder for UserSessionNoteProtocolMapper.