Users can change the default configurations by editing the <PRODUCT_HOME>/repository/conf/identity.xml file using the information given below.
Click on the table and use the left and right arrow keys to scroll horizontally.
XML Elements
| Anchor | ||||
|---|---|---|---|---|
|
| XML element | Attribute | Description | Data type | Default value | Mandatory/Optional | Sample | ||
| <Server> | ||||||||
| _____<JDBCPersistenceManager> | xmlns | |||||||
| _<JDBCPersistenceManager> | Identity related data source configuration. | |||||||
| __________<DataSource> | __ | |||||||
| _____________<Name><Name> | Include a data source name (jndiConfigName) from the set of data sources defined in master-datasources.xml. | String | N/A | Mandatory | <Name>jdbc/WSO2CarbonDB</Name> | |||
| __________<SkipDBSchemaCreation> | If the identity database is created from another place and if it is required to skip schema initialization during the server start up, set the property to "true". | Boolean | FALSE | Optional | ____<SkipDBSchemaCreation>false</SkipDBSchemaCreation> | |||
| _<OpenID> | OpenID related configurations. | |||||||
| __________<OpenIDServerUrl> | This is the URL that the OpenID server (servlet) is running in. | String | N/A | Mandatory | __________<OpenIDUserPattern><OpenIDServerUrl>https://localhost:9443/openidserver</OpenIDServerUrl> | |||
| __<OpenIDUserPattern> | URL of the pattern that can be configured for the user's OpenID. | String | N/A | Mandatory | __________<OpenIDSkipUserConsent> | <OpenIDUserPattern>https://localhost:9443/openid/</OpenIDUserPattern> | ||
| __<OpenIDSkipUserConsent> | Set to false if the users must be prompted for approval. | Boolean | FALSE | Optional | ________<OpenIDSkipUserConsent>false</OpenIDSkipUserConsent> | |||
| __<OpenIDRememberMeExpiry> | Expiry time of the OpenID RememberMe token in minutes. | Int | 0 Minutes | Optional | ________<OpenIDRememberMeExpiry>7200</OpenIDRememberMeExpiry> | |||
| __<UseMultifactorAuthentication> | Multifactor authentication configuration. | Boolean | FALSE | Optional | _______<UseMultifactorAuthentication>false</UseMultifactorAuthentication> | |||
| ___<DisableOpenIDDumbMode> | To enable or disable OpenID dumb mode. | Boolean | FALSE | Optional | <DisableOpenIDDumbMode>false</DisableOpenIDDumbMode> | |||
| __________<SessionTimeout><SessionTimeout> | OpenID session timeout in seconds. | Int | 36000 Seconds | Optional | <SessionTimeout>36000</SessionTimeout> | |||
| __________<AcceptSAMLSSOLogin> | Skips authentication if the valid SAML2 Web SSO browser session is available. | Boolean | FALSE | Optional | ________<AcceptSAMLSSOLogin>false</AcceptSAMLSSOLogin> | |||
| __<ClaimsRetrieverImplClass> | User claim retrieving module for OpenID. | _____<OAuth><ClaimsRetrieverImplClass>org.wso2.carbon.identity.provider.openid.claims.DefaultClaimsRetriever</ClaimsRetrieverImplClass> | ||||||
| _<OAuth> | OAuth related configurations. | |||||||
| __________<AuthorizationCodeDefaultValidityPeriod> | Default validity period for Authorization Code in seconds. | Int | 300 Seconds | Optional | ________<AuthorizationCodeDefaultValidityPeriod>300</AuthorizationCodeDefaultValidityPeriod> | |||
| __<AccessTokenDefaultValidityPeriod> | Default validity period for Access Token in seconds. | Int | 3600 Seconds | Optional | ________<AccessTokenDefaultValidityPeriod>3600</AccessTokenDefaultValidityPeriod> | |||
| __<TimestampSkew> | Timestamp skew in seconds. | Int | 300 Seconds | Optional | ____<TimestampSkew>300</TimestampSkew> | |||
| ______<EnableOAuthCache> | Enable OAuth caching. This cache has the replication support. | Boolean | TRUE | Optional | _______<EnableOAuthCache>true</EnableOAuthCache> | |||
| ___<TokenPersistencePreprocessor> | Configure the security measures needed to be done prior to storing the token in the database, such as hashing, encrypting, etc. | String | org.wso2.carbon.identity.oauth.preprocessor.PlainTokenPersistencePreprocessor | Optional | __________<SupportedResponseTypes><TokenPersistencePreprocessor>org.wso2.carbon.identity.oauth.preprocessor.PlainTextTokenPersistencePreprocessor</TokenPersistencePreprocessor> | |||
| __<SupportedResponseTypes> | Supported OAuth2.0 respose types. | String values with Comma separated | token, code | Optional | ______<SupportedResponseTypes>token,code</SupportedResponseTypes> | |||
| ____<SupportedGrantTypes> | Supported OAuth2.0 grant types. | String values with Comma separated | authorization_code,password,refresh_token,client_credentials,urn:ietf:params:oauth:grant-type:saml2-bearer | Optional | __________<OAuthCallbackHandlers><SupportedGrantTypes>authorization_code,password,refresh_token,client_credentials,urn:ietf:params:oauth:grant-type:saml2-bearer</SupportedGrantTypes> | |||
| __<OAuthCallbackHandlers> | ||||||||
| _______________<OAuthCallbackHandler> | OAuth callback handler module class name. | String | N/A | Mandatory | __________<EnableAssertions><OAuthCallbackHandler class="org.wso2.carbon.identity.oauth.callback.DefaultCallbackHandler"/> | |||
| __<EnableAssertions> | Assertions can be used to embed parameters into the access token. | |||||||
| _______________<UserName> | This enables you to add the user name as an additional parameter if you require it. | Boolean | FALSE | Optional | ___<UserName>false</UserName> | |||
| _______<EnableAccessTokenPartitioning> | This should be set to true when using multiple user stores and keys should be saved into different tables according to the user store. By default, all the application keys are saved into the same table. UserName Assertion should be 'true' to use this. | Boolean | FALSE | Optional | ________<EnableAccessTokenPartitioning>false</EnableAccessTokenPartitioning> | |||
| __<AccessTokenPartitioningDomains> | This includes the user store domain names and mapping to the new table name. E.g., if you provide 'A:foo.com', foo.com should be the user store domain name and 'A' represents the relavant mapping of the token store table, i.e., tokens will be added to a table called IDN_OAUTH2_ACCESS_TOKEN_A. | String values with Comma separated | N/A | Optional | ||||
| __________<AuthorizationContextTokenGeneration> | _________ | |||||||
| ______<Enabled> | This mentions whether token generation is enabled or not. | Boolean | FALSE | Optional | <Enabled>false</Enabled> | |||
| _______________<TokenGeneratorImplClass><TokenGeneratorImplClass> | Token generation class name. | String | org.wso2.carbon.identity.oauth2.token.JWTTokenGenerator | Optional | ______<TokenGeneratorImplClass>org.wso2.carbon.identity.oauth2.authcontext.JWTTokenGenerator</TokenGeneratorImplClass> | |||
| _________<ClaimsRetrieverImplClass> | Claim retrieving class name for generating a token. | org.wso2.carbon.identity.oauth2.token.DefaultClaimsRetriever | Optional | <ClaimsRetrieverImplClass>org.wso2.carbon.identity.oauth2.authcontext.DefaultClaimsRetriever</ClaimsRetrieverImplClass><AuthorizationContextTTL>15</AuthorizationContextTTL> | ||||
| _______________<ConsumerDialectURI><ConsumerDialectURI> | Claim Dialect URI that is used for claim retrieving. | http://wso2.org/claims | Optional | ________<ConsumerDialectURI>http://wso2.org/claims</ConsumerDialectURI> | ||||
| _______<SignatureAlgorithm> | Signature algorithm used for sign the token. | SHA256withRSA | Optional | <SignatureAlgorithm>SHA256withRSA</SignatureAlgorithm> | ||||
| _______________<AuthorizationContextTTL><AuthorizationContextTTL> | Token time to live value. | Long | 15 Minutes | Optional | <AuthorizationContextTTL>15</AuthorizationContextTTL> | |||
| __________<SAML2Grant> | Configuration related to SAML2 Grant type. | |||||||
| __________<OpenIDConnect> | ||||||||
| _______________<IDTokenBuilder> | IDToken generator implementation class name. | String | org.wso2.carbon.identity.openidconnect.DefaultIDTokenBuilder | Optional | <IDTokenBuilder>org.wso2.carbon.identity.openidconnect.DefaultIDTokenBuilder</IDTokenBuilder> | |||
| _______________<IDTokenIssuerID><IDTokenIssuerID> | The value of TokenIssuerID of the IDToken. This is a unique value and should be changed according to the deployment values. | String | OIDCAuthzServer | Optional | __________<IDTokenIssuerID>https://localhost:9443/oauth2endpoints/token</IDTokenIssuerID> | |||
| _____<IDTokenSubjectClaim> | This is the claim used as the subject of the IDToken. You can use different claims such as http://wso2.org/claims/emailaddress. | String | http://wso2.org/claims/fullname | Optional | _<IDTokenSubjectClaim>http://wso2.org/claims/givenname</IDTokenSubjectClaim> | |||
| ______________<IDTokenCustomClaimsCallBackHandler><IDTokenCustomClaimsCallBackHandler> | Claim callback implementation class name. This is used to return custom claims with the IDToken. | String | org.wso2.carbon.identity.openidconnect.SAMLAssertionClaimsCallback | Optional | <IDTokenCustomClaimsCallBackHandler>org.wso2.carbon.identity.openidconnect.SAMLAssertionClaimsCallback</IDTokenCustomClaimsCallBackHandler> | |||
| _______________<IDTokenExpiration> | The expiration value of the IDToken in seconds. | Int | 300 Seconds | Optional | __________<IDTokenExpiration>3600</IDTokenExpiration> | |||
| _____<UserInfoEndpointClaimDialect> | Defines which claim dialect should be returned from the User Endpoint. | String | http://wso2.org/claims/fullname | Optional | <UserInfoEndpointClaimDialect>http://wso2.org/claims</UserInfoEndpointClaimDialect> | |||
| _______________<UserInfoEndpointClaimRetriever><UserInfoEndpointClaimRetriever> | Defines the implemenation name of the class which builds the claims for the user info endpoint's response. | String | org.wso2.carbon.identity.oauth.endpoint.user.impl.UserInfoUserStoreClaimRetriever | Optional | _____<UserInfoEndpointClaimRetriever>org.wso2.carbon.identity.oauth.endpoint.user.impl.UserInfoUserStoreClaimRetriever</UserInfoEndpointClaimRetriever> | |||
| __________<UserInfoEndpointRequestValidator> | Implemenation name of the class that validates the user info request against the specification. | String | org.wso2.carbon.identity.oauth.endpoint.user.impl.UserInforRequestDefaultValidator | Optional | __________<UserInfoEndpointRequestValidator>org.wso2.carbon.identity.oauth.endpoint.user.impl.UserInforRequestDefaultValidator</UserInfoEndpointRequestValidator> | |||
| _____<UserInfoEndpointAccessTokenValidator> | Implementation name of the class that validates the access token. | String | org.wso2.carbon.identity.oauth.endpoint.user.impl.UserInfoISAccessTokenValidator | Optional | __________<UserInfoEndpointAccessTokenValidator>org.wso2.carbon.identity.oauth.endpoint.user.impl.UserInfoISAccessTokenValidator</UserInfoEndpointAccessTokenValidator> | |||
| _____<UserInfoEndpointResponseBuilder> | Implementation name of the class that builds the user info request. | String | org.wso2.carbon.identity.oauth.endpoint.user.impl.UserInfoJSONResponseBuilder | Optional | __<UserInfoEndpointResponseBuilder>org.wso2.carbon.identity.oauth.endpoint.user.impl.UserInfoJSONResponseBuilder</UserInfoEndpointResponseBuilder> | |||
| _____________<SkipUserConsent> | Set to false if the users must be prompted for approval. | Boolean | FALSE | Optional | ___<SkipUserConsent>false</SkipUserConsent> | |||
| __<MultifactorAuthentication> | ||||||||
| __________<XMPPSettings> | XMPP setting for multifactor authentication. | |||||||
| _______________<XMPPConfig> | ||||||||
| ____________________<XMPPProvider> | XMPP provider name. | String | N/A | Mandatory | ________<XMPPProvider>gtalk</XMPPProvider> | |||
| ____________<XMPPServer> | XMPP server name. | String | N/A | Mandatory | _______<XMPPServer>talk.google.com</XMPPServer> | |||
| _____________<XMPPPort> | XMPP server's port. | Int | N/A | Mandatory | __________<XMPPPort>5222</XMPPPort> | |||
| __________<XMPPExt> | XMPP domain. | String | N/A | Mandatory | ___________<XMPPExt>gmail.com</XMPPExt> | |||
| _________<XMPPUserName> | User name for login to XMPP server. | String | N/A | Mandatory | ______________<XMPPUserName>multifactor1@gmail.com</XMPPUserName> | |||
| ______<XMPPPassword> | Password for login to XMPP server. | String | N/A | Mandatory | ___<XMPPPassword>wso2carbon</XMPPPassword> | |||
| __<SSOService> | ||||||||
| __________<IdentityProviderURL> | Unique identifier for IDP. This would be passed as Issuer in SAML2 response. | String | N/A | Mandatory | <IdentityProviderURL>https://localhost:9443/samlsso</IdentityProviderURL> | |||
| __________<SingleLogoutRetryCount> | Number of retries that must be done if a single logout request is not received from the SP. | Int | 5 | Optional | ____<SingleLogoutRetryCount>5</SingleLogoutRetryCount> | |||
| ______<SingleLogoutRetryInterval> | Interval between two re-tries. | Int | 60 Seconds | Optional | <SingleLogoutRetryInterval>60000</SingleLogoutRetryInterval> | |||
| __________<TenantPartitioningEnabled> | This would add the tenant domain as parameter into the ACS URL. | Boolean | FALSE | Optional | ____<TenantPartitioningEnabled>false</TenantPartitioningEnabled> | |||
| ______<SessionTimeout> | Remember me session timeout in seconds. | Int | 36000 Seconds | Optional | ___<SessionTimeout>36000</SessionTimeout> | |||
| _______<AttributesClaimDialect> | Claim Dialect URI that is used for claim retrieving. | String | http://wso2.org/claims | Optional | <AttributesClaimDialect>http://wso2.org/claims</AttributesClaimDialect> | |||
| __________<AcceptOpenIDLogin> | Skips authentication if the valid OpenID login session is available. | Boolean | FALSE | Optional | ____<AcceptOpenIDLogin>false</AcceptOpenIDLogin> | |||
| ______<ClaimsRetrieverImplClass> | Claim retrieving class name for generating a token. | String | N/A | Mandatory | ____<ClaimsRetrieverImplClass>org.wso2.carbon.identity.sso.saml.builders.claims.DefaultClaimsRetriever</ClaimsRetrieverImplClass> | |||
| ______<SAMLResponseValidityPeriod> | SAML Token validity period in minutes. | Int | 5 Minutes | Optional | <SAMLResponseValidityPeriod>5</SAMLResponseValidityPeriod> | |||
| ______<UseAuthenticatedUserDomainCrypto> | When set to true, this is useful in tenant mode setup with older versions of API Manager. This indicates that the SAML2 SSO SAML Response must be signed using the authenticated user's tenant keystore. | Boolean | FALSE | |||||
| __<EntitlementSettings> | ||||||||
| __________<ThirftBasedEntitlementConfig> | Thrift transport configurations for entitlement service. | |||||||
| _______________<EnableThriftService> | Enable thrift transport. | Boolean | FALSE | Optional | <ReceivePort><EnableThriftService>true</EnableThriftService> | |||
| _______<ReceivePort> | Thrift listening port. | Int | N/A | Mandatory | <ClientTimeout><ReceivePort>${Ports.ThriftEntitlementReceivePort}</ReceivePort> | |||
| _______<ClientTimeout> | Thrift session time out in seconds. | Int | N/A | Mandatory | <KeyStore><ClientTimeout>10000</ClientTimeout> | |||
| _______<KeyStore> | Thrift key store configurations used for SSL. | |||||||
| __________<Location> | Key store location | String | N/A | Mandatory | <Password> | Key Store <Location>${carbon.home}/repository/resources/security/wso2carbon.jks</Location> | ||
| ___________<Password> | Key store password | String | N/A | Mandatory | <Password>wso2carbon</Password> | |||
| __<SCIMAuthenticators> | ||||||||
| ____<Authenticator> | Defines implementations of SCIM authenticator. | String | org.wso2.carbon.identity.scim.provider.auth.BasicAuthHandler and org.wso2.carbon.identity.scim.provider.auth.OAuthHandler | Optional | <Property> | Authenticator class="org.wso2.carbon.identity.scim.provider.auth.BasicAuthHandler"> | ||
| ______<Property> | Configuration properties of each autenticator implementation. | String | N/A | Optional | <Property name="Priority">5</Property> |