This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Users can change the default functionality related configurations by editing the <PRODUCT_HOME>/repository/conf/identity.xml file using the information given below.

 

XML Elements 

XML elementDescriptionData typeDefault valueMandatory/OptionalSample
<Server>     
<JDBCPersistenceManager>Identity related data source configuration    
<DataSource>     
<Name>Include a data source name (jndiConfigName) from the set of data sources defined in master-datasources.xmlStringN/AMandatory 
<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".BooleanFALSEOptional 
<OpenID>Open ID related Configurations    
<OpenIDServerUrl>Url that open id server (servlet) is runningStringN/AMandatory 
<OpenIDUserPattern>Url that pattern that can be configured for user's openIdStringN/AMandatory 
<OpenIDSkipUserConsent>Set to false if the users must be prompted for approvalBooleanFALSEOptional 
<OpenIDRememberMeExpiry>Expiry time of the OpenID RememberMe token in minutesInt0 MinutesOptional 
<UseMultifactorAuthentication>Multifactor Authentication configurationBooleanFALSEOptional 
<DisableOpenIDDumbMode>To enable or disable openid dumb modeBooleanFALSEOptional 
<SessionTimeout>OpenID session timeout in secondsInt36000 SecondsOptional 
<AcceptSAMLSSOLogin>Skips authentication if valid SAML2 Web SSO browser session is availableBooleanFALSEOptional 
<ClaimsRetrieverImplClass>User claim retrieving module for OpenID    
      
<OAuth>     
<AuthorizationCodeDefaultValidityPeriod>Default validity period for Authorization Code in secondsInt300 SecondsOptional 
<AccessTokenDefaultValidityPeriod>Default validity period for Access Token in secondsInt3600 SecondsOptional 
<TimestampSkew>Timestamp skew in secondsInt300 SecondsOptional 
<EnableOAuthCache>Enable OAuth caching. This cache has the replication support.BooleanTRUEOptional 
<TokenPersistencePreprocessor>Configure the security measures needs to be done prior to storing the token in the database, such as hashing, encrypting, etc.Stringorg.wso2.carbon.identity.oauth.preprocessor.PlainTokenPersistencePreprocessorOptional 
<SupportedResponseTypes>Supported OAuth2.0 respose types
String values with Comma separated

token,code
Optional 
<SupportedGrantTypes>Supported OAuth2.0 grant typesString values with Comma separatedauthorization_code,password,refresh_token,client_credentials,urn:ietf:params:oauth:grant-type:saml2-bearerOptional 
<OAuthCallbackHandlers>     
<OAuthCallbackHandler>OAuth callback handler module class nameStringN/AMandatory 
<EnableAssertions>Assertions can be used to embed parameters into the access token.    
<UserName>Whether to add user name as addtional parameterBooleanFALSEOptional 
<EnableAccessTokenPartitioning>This should be set to true when using multiple user stores and keys should saved into different tables according to the user store. By default all the application keys are saved in to the same table. UserName Assertion should be 'true' to use this.BooleanFALSEOptional 
<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 separatedN/AOptional 
<AuthorizationContextTokenGeneration>     
<Enabled>
This mentions whether token generation is enabled or not
BooleanFALSEOptional 
<TokenGeneratorImplClass>Token generation class nameStringorg.wso2.carbon.identity.oauth2.token.JWTTokenGeneratorOptional 
<ClaimsRetrieverImplClass>Claim retrieving class name for generating token org.wso2.carbon.identity.oauth2.token.DefaultClaimsRetrieverOptional 
<ConsumerDialectURI>Claim Dialect Uri that is used for claim retrieving http://wso2.org/claimsOptional 
<SignatureAlgorithm>Signature algorithm used for sign the token SHA256withRSAOptional 
<AuthorizationContextTTL>Token time to live valueLong15 MinutesOptional 
<SAML2Grant>Configuration related to SAML2 Grant type    
<OpenIDConnect>     
<IDTokenBuilder>IDToken generator implementation class nameStringorg.wso2.carbon.identity.openidconnect.DefaultIDTokenBuilderOptional 
<IDTokenIssuerID>The value of TokenIssuerID of the IDToken. This is an unique value and should be changed according to the deployment values.StringOIDCAuthzServerOptional 
<IDTokenSubjectClaim>This is the claim used as the subject of the IDToken. You can use
different claims such
as http://wso2.org/claims/emailaddress"
Stringhttp://wso2.org/claims/fullnameOptional 
<IDTokenCustomClaimsCallBackHandler>Claim callback implementation class name.This is used to return custom claims with the IDToken.Stringorg.wso2.carbon.identity.openidconnect.SAMLAssertionClaimsCallbackOptional 
<IDTokenExpiration>The expiration of the IDToken in seconds.Int300 SecondsOptional 
<UserInfoEndpointClaimDialect>Defines which claim dialect should be returned from the User
Endpoint.
Stringhttp://wso2.org/claims/fullnameOptional 
<UserInfoEndpointClaimRetriever>Defines the implemenation name of the class which builds the claims for the user info endpoint's response.Stringorg.wso2.carbon.identity.oauth.endpoint.user.impl.UserInfoUserStoreClaimRetrieverOptional 
<UserInfoEndpointRequestValidator>Implemenation name of the class that validates the user info request against the specificationStringorg.wso2.carbon.identity.oauth.endpoint.user.impl.UserInforRequestDefaultValidatorOptional 
<UserInfoEndpointAccessTokenValidator>Implementation name of the class that validates the access tokenStringorg.wso2.carbon.identity.oauth.endpoint.user.impl.UserInfoISAccessTokenValidatorOptional 
<UserInfoEndpointResponseBuilder>Implementation name of the class that build the user info requestStringorg.wso2.carbon.identity.oauth.endpoint.user.impl.UserInfoJSONResponseBuilderOptional 
<SkipUserConsent>Set to false if the users must be prompted for approvalBooleanFALSEOptional 
      
<MultifactorAuthentication>     
<XMPPSettings>XMPP setting for multifactor authentication    
<XMPPConfig>     
<XMPPProvider>XMPP provider nameStringN/AMandatory 
<XMPPServer>XMPP server nameStringN/AMandatory 
<XMPPPort>XMPP server's portIntN/AMandatory 
<XMPPExt>XMPP domainStringN/AMandatory 
<XMPPUserName>User name for login to XMPP serverStringN/AMandatory 
<XMPPPassword>Password for login to XMPP serverStringN/AMandatory 
      
<SSOService>     
<IdentityProviderURL>Unique identifier for IDP. This would be passed as Issuer in SAML2 responseStringN/AMandatory 
<SingleLogoutRetryCount>Number of retries that must be done, if single logout request is not received from a SPInt5Optional 
<SingleLogoutRetryInterval>Interval between two re-triesInt60 SecondsOptional 
<TenantPartitioningEnabled>This would add the tenant domain as parameter in to ACS urlBooleanFALSEOptional 
<SessionTimeout>Remember me session timeout in secondsInt36000 SecondsOptional 
<AttributeStatementBuilder>
This configuration is not used now. this is needed to remove
    
<AttributesClaimDialect>Claim Dialect Uri that is used for claim retrievingString
http://wso2.org/claims
Optional 
<AcceptOpenIDLogin>Skips authentication if valid Open ID login session is availableBooleanFALSEOptional 
<ClaimsRetrieverImplClass>Claim retrieving class name for generating tokenStringN/AMandatory 
<SAMLResponseValidityPeriod>SAML Token validity period in minutes.Int5 MinutesOptional 
      
<EntitlementSettings>     
<ThirftBasedEntitlementConfig>Thrift transport configurations for entitlement service    
<EnableThriftService>Enable thrift transportBooleanFALSEOptional 
<ReceivePort>Thrift listening portIntN/AMandatory 
<ClientTimeout>Thrift session time out in secondsIntN/AMandatory 
<KeyStore>Thrift key store configurations used for SSL    
<Location>Key store locationStringN/AMandatory 
<Password>Key Store passwordStringN/AMandatory 
<SCIMAuthenticators>     
<Authenticator>Defines implementations of SCIM authenticatorStringorg.wso2.carbon.identity.scim.provider.auth.BasicAuthHandler and org.wso2.carbon.identity.scim.provider.auth.OAuthHandlerOptional 
<Property>Configuration properties of each autenticator implementationStringN/AOptional 
  • No labels