ÃÛ¶¹ÊÓƵ

DocumentationÃÛ¶¹ÊÓƵ PassÃÛ¶¹ÊÓƵ Pass Authentication

Header - AD-Service-Token header-ad-service-token

Last update: Wed Mar 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
The content on this page is provided for information purposes only. Usage of this API requires a current license from ÃÛ¶¹ÊÓƵ. No unauthorized use is permitted.

Overview overview

The AD-Service-Token request header contains the unique user identifier as JWS obtained from an identity service running outside of ÃÛ¶¹ÊÓƵ Pass Authentication systems.

This header is designed for use in single sign-on (SSO) enabled flows leveraging the Service Token method.

For more details about the single sign-on (SSO) enabled flows leveraging the Service Token method, refer to the Single sign-on using service token flows documentation.

Syntax syntax

AD-Service-Token: <unique_user_identifier>
Header Type
Request header
Standard
No

Directives directives

unique_user_identifier

The JSON Web Signature (JWS) which is a signed JSON Web Token (JWT) containing unique user identifier information.

The JWT has the following attributes:

Attribute
Description
iss
The unique identifier associated with the entity that offers the application an external identity service to achieve single sign-on (SSO).
sub
The unique identifier for the user as returned by the external identity service.
aud
The audience, which should be "ÃÛ¶¹ÊÓƵ".
iat
The issued at timestamp for the present JWT.
exp
The expiration timestamp for the present JWT.

The JWT must be signed using SHA256withRSA algorithm.

The JWT must be signed with a private key, part of a pair of RSA private key - public key managed by the external identity service.

The public key of that pair must be handed over to ÃÛ¶¹ÊÓƵ Pass Authentication in order to be able to recognise JWT tokens signed with the aforementioned private key.

Examples examples

// JWT
// Header
// {
//  "alg": "RS256",
//  "kid": "qapEaY0hYNvphytwII3Sae_cAKyLS7GZOqtT_a4ajeo"
// }
// Payload data
// {
//  "sub": "Jane",
//  "name": "Jane Smith",
//  "iat": 1516239022,
//  "iss": "adobe",
//  "exp": 1720152820,
//  "aud": "adobe",
//  "jti": "3b2fb040-30a9-43d7-b647-d00ac495bab"
// }

// JWS
// eyJhbGciOiJSUzI1NiIsImtpZCI6InFhcEVhWTBoWU52cGh5dHdJSTNTYWVfY0FLeUxTN0daT3F0VF9hNGFqZW8ifQ.eyJzdWIiOiJKYW5lIiwibmFtZSI6IkphbmUgU21pdGgiLCJpYXQiOjE1MTYyMzkwMjIsImlzcyI6ImFkb2JlIiwiZXhwIjoxNzIwMTUyODIwLCJhdWQiOiJhZG9iZSIsImp0aSI6IjNiMmZiMDQwLTMwYTktNDNkNy1iNjQ3LWQwMGFjNDk1YmFiIn0.stHLZFh-635LDNjv9HRHzq912ICNCVGUS3f4RS_bAxpUiUSB6CShS2VvU4V-THEXj7d_zk1mxtPP0QM_pCrh4Vk2GaPRa856Bt_PhsfQY-_benDcB6MIoFX67qrREGncGiv7JEs3ksa-P1YvBYXolT7t52K093kFaQtICfB-aBa8danRZvUrJHjjFoILEpTbQuzxKRN6y36J3p1FZ-SfDuofHp3SnXDrWFRYyXYQnb9WFlhNBxR400-0vzTONZYd097WWy1shMw5V8TvIDvCDE5ifqk31gMdYga-N3JkcTA5QoW7Zl80UV7BhR5v14Va1IZLcbFra_UJdEzbBwW_nA

AD-Service-Token: eyJhbGciOiJSUzI1NiIsImtpZCI6InFhcEVhWTBoWU52cGh5dHdJSTNTYWVfY0FLeUxTN0daT3F0VF9hNGFqZW8ifQ.eyJzdWIiOiJKYW5lIiwibmFtZSI6IkphbmUgU21pdGgiLCJpYXQiOjE1MTYyMzkwMjIsImlzcyI6ImFkb2JlIiwiZXhwIjoxNzIwMTUyODIwLCJhdWQiOiJhZG9iZSIsImp0aSI6IjNiMmZiMDQwLTMwYTktNDNkNy1iNjQ3LWQwMGFjNDk1YmFiIn0.stHLZFh-635LDNjv9HRHzq912ICNCVGUS3f4RS_bAxpUiUSB6CShS2VvU4V-THEXj7d_zk1mxtPP0QM_pCrh4Vk2GaPRa856Bt_PhsfQY-_benDcB6MIoFX67qrREGncGiv7JEs3ksa-P1YvBYXolT7t52K093kFaQtICfB-aBa8danRZvUrJHjjFoILEpTbQuzxKRN6y36J3p1FZ-SfDuofHp3SnXDrWFRYyXYQnb9WFlhNBxR400-0vzTONZYd097WWy1shMw5V8TvIDvCDE5ifqk31gMdYga-N3JkcTA5QoW7Zl80UV7BhR5v14Va1IZLcbFra_UJdEzbBwW_nA
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b