Token endpoint
The client presents its authorization grant to the token endpoint to obtain an access token and a refresh token when needed.
The OAuth 2.0 Authorization Framework defines the token endpoint. Because the authorization endpoint directly issues an access token, every authorization grant uses this endpoint except the Implicit grant type.
This endpoint accepts only the HTTP POST method. |
Endpoint: /as/token.oauth2
Parameters vary depending on the grant type. For more information, see OAuth grant type parameters. The required Content-Type
value is application/x-www-form-urlencoded
.
Like other OAuth 2.0 endpoints, the token endpoint is accessible at the base URL and any configured virtual host names.
If the Token Endpoint Base URL field is configured on the Authorization Server Settings window (System → OAuth Settings → Authorization Server Settings) the token endpoint is also accessible at that location.
For example, if the base URL is https://www.example.com:9031 and the Token Endpoint Base URL value is https://www.example.local:9031, the token endpoints are accessible at the following locations:
-
https://www.example.com:9031/as/token.oauth2
-
https://www.example.local:9031/as/token.oauth2
OAuth client identification and authentication
The authentication requirement of this endpoint depends on the client authentication method configured for the clients.
Authentication method | Parameters | ||
---|---|---|---|
Client secret |
Clients can present their client identifier and client secret using the HTTP Basic authentication scheme, where the client identifier is the username, and the client secret is the password. Clients can provide credentials using the request parameters
|
||
Client certificate |
Clients must present their client certificate for mutual TLS authentication. The issuer and the subject distinguished name (DN) of the client certificate must match values configured for the clients. |
||
Private key JWT or Client Secret JWT |
Clients must include request parameters
Example ... client_assertion_type= urn%3Aietf%3Aparams%3Aoauth% 3Aclient-assertion-type%3Ajwt-bearer& client_assertion= eyJhbGciOiJSUzI1NiIs...LbSWi1YO-TILOd4L7ZCg& ...
For more information about the private_key_jwt and client_secret_jwt client authentication methods, see Client Authentication and Using Assertions for Client Authentication. |
||
None |
Clients must pass in the |
OAuth access token management parameters
PingFederate supports multiple access token management (ATM) instances. Clients can specify an ATM instance by providing the ATM ID (access_token_manager_id
) or a resource URI (aud
) in their requests to the PingFederate OAuth AS.
Parameter | Description | ||
---|---|---|---|
|
The
|
||
|
The |
A match can be an exact match or a partial match where the provided URI has the same scheme and authority parts and a more specific path contained within the path of the pre-configured resource URI. PingFederate takes an exact match over a partial match. If there are multiple partial matches, PingFederate takes the partial match where the provided URI matches more specifically against the pre-configured resource URI.