Configuring an identity mapping
About this task
A header identity mapping can expose one or more attribute values to the protected API in HTTP request headers.
For more information about this procedure, including optional steps that are not included here, see Creating header identity mappings.
Steps
-
Click Access and then go to Identity Mappings → Identity Mappings.
-
Click Add Identity Mapping.
-
In the Name field, enter a name for the mapping.
-
From the Type list, select Header Identity Mapping.
-
In the Attribute to Header Mapping section, in the Attribute Name field, enter the name of the attribute to retrieve from the user web session. For example,
sub
. -
In the Header Name field, enter the name of the header to contain the attribute value.
The HTTP header you specify here is the actual header name over the HTTP protocol, not an environment variable interpreted format. For example, enter the
User-Agent
browser type identifying header asUser-Agent
, notHTTP_USER_AGENT
. -
In the Certificate to Header Mapping section, enter the header name included in a PEM-encoded client certificate.
The row position correlates to the index in the client certificate chain. For example, the first row always maps to the leaf certificate. If you are using a certificate chain, click Add Row to add another row.
-
Click Save.