IdentityProvider Migrations #
All migrations referring to the identityprovider resource.
AddKeycloakIdentityProvider #
Adds a keycloak identity provider.
Parameters #
- realm: String, optional
- alias: String, not optional
- authorizationUrl: String, not optional
- tokenUrl: String, not optional
- clientId: String, not optional
- clientSecret: String, not optional
- clientAuthMethod: String, optional, default = “client_secret_post”
- logoutUrl: String, optional, default = "”
- userInfoUrl: String, optional, default = "”
- issuer: String, optional, default = "”
- displayName: String, optional, default = "”
- defaultScopes: List< String>, optional, default = emptyList()
- validateSignature: String, optional, default = "”
- forwardParameters: List, optional, default = emptyList()
- loginHint: Boolean, optional, default = false
- disableUserInfo: Boolean, optional, default = false
- hideOnLoginPage: Boolean, optional, default = false
- backchannelSupported: Boolean, optional, default = false
- syncMode: String, optional, default = “IMPORT”
- acceptsPromptsNoneForwardFromClient: String, optional, default = "”
- uiLocales: Boolean, optional, default = true
- guiOrder: String, optional, default = "”
- useJwksUrl: Boolean, optional, default = false
- enabled: Boolean, optional, default = true
- trustEmail: Boolean, optional, default = false
- storeToken: Boolean, optional, default = false
- linkOnly: Boolean, optional, default = false
- firstBrokerLoginFlowAlias: String, optional, default = “first broker login”
- postBrokerLoginFlowAlias: String, optional, default = "”
- updateProfileFirstLoginMode: String, optional, default = “on”
Example #
id: add-keycloak-identity-provider
author: klg71
realm: integ-test
changes:
- addKeycloakIdentityProvider:
alias: testAlias
authorizationUrl: https://authUrl
tokenUrl: https://tokenUrl
clientId: clientId
clientSecret: clientSecret
hideOnLoginPage: true
backchannelSupported: true
trustEmail: true
storeToken: true
UpdateKeycloakIdentityProvider #
Updates given fields of an existing keycloak identity provider but leaves all not provided fields untouched.
Parameters #
- realm: String, optional
- alias: String, not optional
- authorizationUrl: String, optional
- tokenUrl: String, optional
- clientId: String, optional
- clientSecret: String, optional
- clientAuthMethod: String, optional
- logoutUrl: String, optional
- userInfoUrl: String, optional
- issuer: String, optional
- displayName: String, optional
- defaultScopes: List< String>, optional
- validateSignature: String, optional
- forwardParameters: List, optional
- loginHint: Boolean, optional
- disableUserInfo: Boolean, optional
- hideOnLoginPage: Boolean, optional
- backchannelSupported: Boolean, optional
- syncMode: String, optional
- acceptsPromptsNoneForwardFromClient: String, optional
- uiLocales: Boolean, optional
- guiOrder: String, optional
- useJwksUrl: Boolean, optional
- enabled: Boolean, optional
- trustEmail: Boolean, optional
- storeToken: Boolean, optional
- linkOnly: Boolean, optional
- firstBrokerLoginFlowAlias: String, optional
- postBrokerLoginFlowAlias: String, optional
- updateProfileFirstLoginMode: String, optional
Example #
id: update-keycloak-identity-provider
author: sideisra
realm: integ-test
changes:
- updateKeycloakIdentityProvider:
alias: testAlias
clientId: newClientId
storeToken: false
DeleteIdentityProvider #
Deletes an identity provider, if one with this alias exists
Parameters #
- realm: String, optional
- alias: String, not optional
Example #
id: delete-identity-provider
author: klg71
realm: integ-test
changes:
- addIdentityProvider:
alias: testAlias1
providerId: keycloak-oidc
trustEmail: true
storeToken: true
config:
hideOnLoginPage: true
backchannelSupported: true
authorizationUrl: https://authUrl
tokenUrl: https://tokenUrl
clientId: clientId
clientSecret: clientSecret
- deleteIdentityProvider:
alias: testAlias1
AddIdentityProvider #
Adds a generic identity provider, exact configuration has to be reverse engineered through the keycloak web frontend. If you need an identity provider please open an issue or file a pull request.
Specific IdentityProvider actions (e.g. for Keycloak) are listed below
Parameters #
-
realm: String, optional
-
alias: String, not optional
-
providerId: String, not optional
-
config: Map<String, String> not optional
configuration properties include for example:
- acceptsPromptNoneForwardFromClient
- authorizationUrl
- backchannelSupported
- clientAuthMethod
- clientId
- clientSecret
- defaultScope
- disableUserInfo
- forwardParameters
- guiOrder
- hideOnLoginPage
- issuer
- loginHint
- logoutUrl
- syncMode
- tokenUrl
- uiLocales
- useJwksUrl
- userInfoUrl
- validateSignature
-
displayName: String, optional, default=””
-
enabled: Boolean, optional, default = true
-
trustEmail: Boolean, optional, default = false
-
storeToken: Boolean, optional, default = false
-
linkOnly: Boolean, optional, default = false
-
firstBrokerLoginFlowAlias: String, optional, default = “first broker login”
-
postBrokerLoginFlowAlias: String, optional, default = "”
Example #
id: add-identity-provider
author: klg71
realm: integ-test
changes:
- addIdentityProvider:
alias: testAlias1
providerId: keycloak-oidc
trustEmail: true
storeToken: true
config:
hideOnLoginPage: true
backchannelSupported: true
authorizationUrl: https://authUrl
tokenUrl: https://tokenUrl
clientId: clientId
clientSecret: clientSecret
UpdateIdentityProvider #
Updates given fields of an existing keycloak identity provider but leaves all not provided fields untouched.
Updates given fields of a generic identity provider but leaves all not provided fields untouched. The exact configuration has to be reverse engineered through the keycloak web frontend. If you need an identity provider please open an issue or file a pull request.
Specific IdentityProvider actions (e.g. for Keycloak) are listed below
Parameters #
-
realm: String, optional
-
alias: String, not optional
-
providerId: String, optional
-
config: Map<String, String>, optional
configuration properties include for example:
- acceptsPromptNoneForwardFromClient
- authorizationUrl
- backchannelSupported
- clientAuthMethod
- clientId
- clientSecret
- defaultScope
- disableUserInfo
- forwardParameters
- guiOrder
- hideOnLoginPage
- issuer
- loginHint
- logoutUrl
- syncMode
- tokenUrl
- uiLocales
- useJwksUrl
- userInfoUrl
- validateSignature
-
displayName: String optional
-
enabled: Boolean, optional
-
trustEmail: Boolean, optional
-
storeToken: Boolean, optional
-
linkOnly: Boolean, optional
-
firstBrokerLoginFlowAlias: String, optional
-
postBrokerLoginFlowAlias: String, optional
Example #
id: update-identity-provider
author: sideisra
realm: integ-test
changes:
- updateIdentityProvider:
alias: testAlias1
storeToken: false
config:
clientId: newClientId