--- title: UMA configuration reference description: This topic provides reference information for UMA global settings and UMA datastore settings. See the general Reference for reference information on global services. component: pingam version: 7.2 page_id: pingam:uma-guide:uma-reference canonical_url: https://docs.pingidentity.com/pingam/8.1/uma/uma-reference.html llms_txt: https://docs.pingidentity.com/pingam/llms.txt docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md superseded_by: https://docs.pingidentity.com/pingam/8.1/uma/uma-reference.html section_ids: server-uma: UMA properties uma-ref-resource-set-store: UMA resource store uma-ref-external-resource-set-store: External UMA resource store configuration uma-ref-audit-store: UMA audit store uma-ref-external-audit-store: External UMA audit store configuration uma-ref-pending-store: Pending requests store uma-ref-external-pending-store: External pending requests store configuration uma-ref-labels-store: UMA resource labels store uma-ref-external-labels-store: External UMA resource labels store configuration --- # UMA configuration reference This topic provides reference information for UMA global settings and UMA datastore settings. See the general [Reference](../reference/preface.html) for reference information on global services. * To configure UMA global settings, go to Configure > Global Settings > UMA Provider. For more information, see [UMA provider](../reference/global-services-configuration.html#global-uma). * To configure UMA datastore settings: * Go to Configure > Server Defaults > UMA to configure the settings for all your servers. * Go to Deployment > Servers > *Server Name* > UMA to configure the settings for one server. For more information, see [UMA properties](#server-uma). ## UMA properties UMA server settings are inherited by default. ### UMA resource store The following settings appear on the UMA Resource Store tab: * Store Mode Specifies the data store where AM stores UMA tokens. Possible values are: * `Default Token Store`: AM stores UMA tokens in the configuration data store. * `External Token Store`: AM stores UMA tokens in an external data store. * Root Suffix Specifies the base DN for storage information in LDAP format, such as `dc=uma-resources,dc=example,dc=com`. * Max Connections Specifies the maximum number of connections to the data store. ### External UMA resource store configuration AM honors the following properties when `External Token Store` is selected under the Resource Sets Store tab: * SSL/TLS Enabled When enabled, AM uses SSL or TLS to connect to the external data store. Make sure AM trusts the data store's certificate when using this option. * Connection String(s) Specifies an ordered list of connection strings for external data stores. The format is `HOST:PORT[|SERVERID[|SITEID]]`, where `HOST:PORT` specify the FQDN and port of the data store, and `SERVERID` and `SITEID` are optional parameters that let you prioritize the particular connection when used by the specified node(s). Multiple connection strings must be comma-separated, for example, `uma-ldap1.example.com:389|1|1, uma-ldap2.example.com:389|2|1`. See the entry for Connection String(s) in [CTS properties](../reference/deployment-configuration-reference.html#server-cts) for more syntax examples. * Login Id Specifies the username AM uses to authenticate to the data store. For example, `uid=am-uma-bind-account,ou=admins,dc=uma,dc=example,dc=com`. This user must be able to read and write to the root suffix of the data store. * Password Specifies the password associated with the login ID property. * Heartbeat Specifies, in seconds, how often AM should send a heartbeat request to the data store to ensure that the connection does not remain idle. Default: `10` ### UMA audit store The following settings appear on the UMA Audit Store tab: * Store Mode Specifies the data store where AM stores audit information generated when users access UMA resources. Possible values are: * `Default Token Store`: AM stores UMA audit information in the configuration data store. * `External Token Store`: AM stores UMA audit information in an external data store. * Root Suffix Specifies the base DN for storage information in LDAP format, such as `dc=uma-audit,dc=example,dc=com`. * Max Connections Specifies the maximum number of connections to the data store. ### External UMA audit store configuration AM honors the following properties when `External Token Store` is selected under the UMA Audit Store tab: * SSL/TLS Enabled When enabled, AM uses SSL or TLS to connect to the external data store. Make sure AM trusts the data store's certificate when using this option. * Connection String(s) Specifies an ordered list of connection strings for external data stores. The format is `HOST:PORT[|SERVERID[|SITEID]]`, where `HOST:PORT` specify the FQDN and port of the data store, and `SERVERID` and `SITEID` are optional parameters that let you prioritize the particular connection when used by the specified node(s). Multiple connection strings must be comma-separated, for example, `uma-ldap1.example.com:389|1|1, uma-ldap2.example.com:389|2|1`. See the entry for Connection String(s) in [CTS properties](../reference/deployment-configuration-reference.html#server-cts) for more syntax examples. * Login Id Specifies the username AM uses to authenticate to the data store. For example, `uid=am-uma-bind-account,ou=admins,dc=uma,dc=example,dc=com`. This user must be able to read and write to the root suffix of the data store. * Password Specifies the password associated with the login ID property. * Heartbeat Specifies, in seconds, how often AM should send a heartbeat request to the data store to ensure that the connection does not remain idle. Default: `10` ### Pending requests store The following settings appear on the Pending Requests Store tab: * Store Mode Specifies the data store where AM stores pending requests to UMA resources. Possible values are: * `Default Token Store`: AM stores UMA pending requests in the configuration data store. * `External Token Store`: AM stores UMA pending requests in an external data store. * Root Suffix Specifies the base DN for storage information in LDAP format, such as `dc=uma-pending,dc=forgerock,dc=com`. * Max Connections Specifies the maximum number of connections to the data store. ### External pending requests store configuration AM honors the following properties when `External Token Store` is selected under the Pending Requests Store tab: * SSL/TLS Enabled When enabled, AM uses SSL or TLS to connect to the external data store. Make sure AM trusts the data store's certificate when using this option. * Connection String(s) Specifies an ordered list of connection strings for external data stores. The format is `HOST:PORT[|SERVERID[|SITEID]]`, where `HOST:PORT` specify the FQDN and port of the data store, and `SERVERID` and `SITEID` are optional parameters that let you prioritize the particular connection when used by the specified node(s). Multiple connection strings must be comma-separated, for example, `uma-ldap1.example.com:389|1|1, uma-ldap2.example.com:389|2|1`. See the entry for Connection String(s) in [CTS properties](../reference/deployment-configuration-reference.html#server-cts) for more syntax examples. * Login Id Specifies the username AM uses to authenticate to the data store. For example, `uid=am-uma-bind-account,ou=admins,dc=uma,dc=example,dc=com`. This user must be able to read and write to the root suffix of the data store. * Password Specifies the password associated with the login ID property. * Heartbeat Specifies, in seconds, how often AM should send a heartbeat request to the data store to ensure that the connection does not remain idle. Default: `10` ### UMA resource labels store The following settings appear on the UMA Resource Labels Store tab: * Store Mode Specifies the data store where AM stores user-created labels used for organizing UMA resources. Possible values are: * `Default Token Store`: AM stores user-created labels in the configuration data store. * `External Token Store`: AM stores user-created labels in an external data store. * Root Suffix Specifies the base DN for storage information in LDAP format, such as `dc=uma-resources-labels,dc=forgerock,dc=com`. * Max Connections Specifies the maximum number of connections to the data store. ### External UMA resource labels store configuration AM honors the following properties when `External Token Store` is selected under the UMA Resource Labels Store tab. * SSL/TLS Enabled When enabled, AM uses SSL or TLS to connect to the external data store. Make sure AM trusts the data store's certificate when using this option. * Connection String(s) Specifies an ordered list of connection strings for external data stores. The format is `HOST:PORT[|SERVERID[|SITEID]]`, where `HOST:PORT` specify the FQDN and port of the data store, and `SERVERID` and `SITEID` are optional parameters that let you prioritize the particular connection when used by the specified node(s). Multiple connection strings must be comma-separated, for example, `uma-ldap1.example.com:389|1|1, uma-ldap2.example.com:389|2|1`. See the entry for Connection String(s) in [CTS properties](../reference/deployment-configuration-reference.html#server-cts) for more syntax examples. * Login Id Specifies the username AM uses to authenticate to the data store. For example, `uid=am-uma-bind-account,ou=admins,dc=uma,dc=example,dc=com`. This user must be able to read and write to the root suffix of the data store. * Password Specifies the password associated with the login ID property. * Heartbeat Specifies, in seconds, how often AM should send a heartbeat request to the data store to ensure that the connection does not remain idle. Default: `10`