pulumi-keycloak-kotlin/com.pulumi.keycloak.saml.kotlin

Package-level declarations

Types

class Client : KotlinCustomResource

Allows for creating and managing Keycloak clients that use the SAML 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.

ClientArgs

data class ClientArgs(val assertionConsumerPostUrl: Output<String>? = null, val assertionConsumerRedirectUrl: Output<String>? = null, val authenticationFlowBindingOverrides: Output<ClientAuthenticationFlowBindingOverridesArgs>? = null, val baseUrl: Output<String>? = null, val canonicalizationMethod: Output<String>? = null, val clientId: Output<String>? = null, val clientSignatureRequired: Output<Boolean>? = null, val description: Output<String>? = null, val enabled: Output<Boolean>? = null, val encryptAssertions: Output<Boolean>? = null, val encryptionCertificate: Output<String>? = null, val extraConfig: Output<Map<String, String>>? = null, val forceNameIdFormat: Output<Boolean>? = null, val forcePostBinding: Output<Boolean>? = null, val frontChannelLogout: Output<Boolean>? = null, val fullScopeAllowed: Output<Boolean>? = null, val idpInitiatedSsoRelayState: Output<String>? = null, val idpInitiatedSsoUrlName: Output<String>? = null, val includeAuthnStatement: Output<Boolean>? = null, val loginTheme: Output<String>? = null, val logoutServicePostBindingUrl: Output<String>? = null, val logoutServiceRedirectBindingUrl: Output<String>? = null, val masterSamlProcessingUrl: Output<String>? = null, val name: Output<String>? = null, val nameIdFormat: Output<String>? = null, val realmId: Output<String>? = null, val rootUrl: Output<String>? = null, val signAssertions: Output<Boolean>? = null, val signDocuments: Output<Boolean>? = null, val signatureAlgorithm: Output<String>? = null, val signatureKeyName: Output<String>? = null, val signingCertificate: Output<String>? = null, val signingPrivateKey: Output<String>? = null, val validRedirectUris: Output<List<String>>? = null) : ConvertibleToJava<ClientArgs>

ClientArgsBuilder

class ClientArgsBuilder

Builder for ClientArgs.

ClientDefaultScope

class ClientDefaultScope : KotlinCustomResource

ClientDefaultScopeArgs

data class ClientDefaultScopeArgs(val clientId: Output<String>? = null, val defaultScopes: Output<List<String>>? = null, val realmId: Output<String>? = null) : ConvertibleToJava<ClientDefaultScopeArgs>

ClientDefaultScopeArgsBuilder

class ClientDefaultScopeArgsBuilder

Builder for ClientDefaultScopeArgs.

ClientDefaultScopeMapper

object ClientDefaultScopeMapper : ResourceMapper<ClientDefaultScope>

ClientDefaultScopeResourceBuilder

class ClientDefaultScopeResourceBuilder

Builder for ClientDefaultScope.

ClientMapper

object ClientMapper : ResourceMapper<Client>

ClientResourceBuilder

class ClientResourceBuilder

Builder for Client.

ClientScope

class ClientScope : KotlinCustomResource

Allows for creating and managing Keycloak client scopes that can be attached to clients that use the SAML protocol. Client Scopes can be used to share common protocol and role mappings between multiple clients within a realm.

ClientScopeArgs

data class ClientScopeArgs(val consentScreenText: Output<String>? = null, val description: Output<String>? = null, val guiOrder: Output<Int>? = null, val name: Output<String>? = null, val realmId: Output<String>? = null) : ConvertibleToJava<ClientScopeArgs>

ClientScopeArgsBuilder

class ClientScopeArgsBuilder

Builder for ClientScopeArgs.

ClientScopeMapper

object ClientScopeMapper : ResourceMapper<ClientScope>

ClientScopeResourceBuilder

class ClientScopeResourceBuilder

Builder for ClientScope.

IdentityProvider

class IdentityProvider : KotlinCustomResource

Allows for creating and managing SAML Identity Providers within Keycloak. SAML (Security Assertion Markup Language) identity providers allows users to authenticate through a third-party system using the SAML protocol.

IdentityProviderArgs

data class IdentityProviderArgs(val addReadTokenRoleOnCreate: Output<Boolean>? = null, val alias: Output<String>? = null, val authenticateByDefault: Output<Boolean>? = null, val authnContextClassRefs: Output<List<String>>? = null, val authnContextComparisonType: Output<String>? = null, val authnContextDeclRefs: Output<List<String>>? = null, val backchannelSupported: Output<Boolean>? = null, val displayName: Output<String>? = null, val enabled: Output<Boolean>? = null, val entityId: Output<String>? = null, val extraConfig: Output<Map<String, String>>? = null, val firstBrokerLoginFlowAlias: Output<String>? = null, val forceAuthn: Output<Boolean>? = null, val guiOrder: Output<String>? = null, val hideOnLoginPage: Output<Boolean>? = null, val linkOnly: Output<Boolean>? = null, val loginHint: Output<String>? = null, val nameIdPolicyFormat: Output<String>? = null, val postBindingAuthnRequest: Output<Boolean>? = null, val postBindingLogout: Output<Boolean>? = null, val postBindingResponse: Output<Boolean>? = null, val postBrokerLoginFlowAlias: Output<String>? = null, val principalAttribute: Output<String>? = null, val principalType: Output<String>? = null, val providerId: Output<String>? = null, val realm: Output<String>? = null, val signatureAlgorithm: Output<String>? = null, val signingCertificate: Output<String>? = null, val singleLogoutServiceUrl: Output<String>? = null, val singleSignOnServiceUrl: Output<String>? = null, val storeToken: Output<Boolean>? = null, val syncMode: Output<String>? = null, val trustEmail: Output<Boolean>? = null, val validateSignature: Output<Boolean>? = null, val wantAssertionsEncrypted: Output<Boolean>? = null, val wantAssertionsSigned: Output<Boolean>? = null, val xmlSignKeyInfoKeyNameTransformer: Output<String>? = null) : ConvertibleToJava<IdentityProviderArgs>

IdentityProviderArgsBuilder

class IdentityProviderArgsBuilder

Builder for IdentityProviderArgs.

IdentityProviderMapper

object IdentityProviderMapper : ResourceMapper<IdentityProvider>

IdentityProviderResourceBuilder

class IdentityProviderResourceBuilder

Builder for IdentityProvider.

SamlFunctions

object SamlFunctions

ScriptProtocolMapper

class ScriptProtocolMapper : KotlinCustomResource

Allows for creating and managing script protocol mappers for SAML clients within Keycloak. Script protocol mappers evaluate a JavaScript function to produce an attribute value 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.

ScriptProtocolMapperArgs

data class ScriptProtocolMapperArgs(val clientId: Output<String>? = null, val clientScopeId: Output<String>? = null, val friendlyName: Output<String>? = null, val name: Output<String>? = null, val realmId: Output<String>? = null, val samlAttributeName: Output<String>? = null, val samlAttributeNameFormat: Output<String>? = null, val script: Output<String>? = null, val singleValueAttribute: Output<Boolean>? = null) : ConvertibleToJava<ScriptProtocolMapperArgs>

ScriptProtocolMapperArgsBuilder

class ScriptProtocolMapperArgsBuilder

Builder for ScriptProtocolMapperArgs.

ScriptProtocolMapperMapper

object ScriptProtocolMapperMapper : ResourceMapper<ScriptProtocolMapper>

ScriptProtocolMapperResourceBuilder

class ScriptProtocolMapperResourceBuilder

Builder for ScriptProtocolMapper.

UserAttributeProtocolMapper

class UserAttributeProtocolMapper : KotlinCustomResource

Allows for creating and managing user attribute protocol mappers for SAML clients within Keycloak. SAML user attribute protocol mappers allow you to map custom attributes defined for a user within Keycloak to an attribute in a SAML assertion. 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.

UserAttributeProtocolMapperArgs

data class UserAttributeProtocolMapperArgs(val clientId: Output<String>? = null, val clientScopeId: Output<String>? = null, val friendlyName: Output<String>? = null, val name: Output<String>? = null, val realmId: Output<String>? = null, val samlAttributeName: Output<String>? = null, val samlAttributeNameFormat: Output<String>? = null, val userAttribute: Output<String>? = null) : ConvertibleToJava<UserAttributeProtocolMapperArgs>

UserAttributeProtocolMapperArgsBuilder

class UserAttributeProtocolMapperArgsBuilder

Builder for UserAttributeProtocolMapperArgs.

UserAttributeProtocolMapperMapper

object UserAttributeProtocolMapperMapper : ResourceMapper<UserAttributeProtocolMapper>

UserAttributeProtocolMapperResourceBuilder

class UserAttributeProtocolMapperResourceBuilder

Builder for UserAttributeProtocolMapper.

UserPropertyProtocolMapper

class UserPropertyProtocolMapper : KotlinCustomResource

Allows for creating and managing user property protocol mappers for SAML clients within Keycloak. SAML user property protocol mappers allow you to map properties of the Keycloak user model to an attribute in a SAML assertion. 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.

UserPropertyProtocolMapperArgs

data class UserPropertyProtocolMapperArgs(val clientId: Output<String>? = null, val clientScopeId: Output<String>? = null, val friendlyName: Output<String>? = null, val name: Output<String>? = null, val realmId: Output<String>? = null, val samlAttributeName: Output<String>? = null, val samlAttributeNameFormat: Output<String>? = null, val userProperty: Output<String>? = null) : ConvertibleToJava<UserPropertyProtocolMapperArgs>