POST OAuth/GetJwtMapping
Returns an OAuth JWT mapping
Requirements
- Roles: Admin or Auditor. See OAuth roles for more information.
- Token scope: Admin
Headers
-
Content type: Content-Type:application/json.
- Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.
Parameters
Name |
Description |
---|---|
Name string |
The name of the mapping to return. |
ResolveIdentities boolean |
If |
Returns
Name |
Description |
---|---|
HTTP 200 |
See OAuth result codes. The following values are returned:
|
HTTP 400 |
For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:
|
HTTP 401 |
For authentication errors, this call returns HTTP 401 Unauthorized and the following data in the message body:
|
HTTP 403 |
If the response is HTTP 403 Forbidden, the requester's token does not include the admin scope. Call POST Authorize/OAuth with the correct scope and restriction. Update the header with the new token and retry.
|
Examples
Request
POST /vedsdk/oauth/GetJwtMapping HTTP/1.1 Host: tpp-server-url Content-Type: application/json Accept: application/json Authorization: Bearer 4MyGeneratedBearerTknz== { "Name": "Example JWT mapping", "ResolveIdentities": true }
Response
{ "IdentityEntries": [ { "FullName": "\\VED\\Identity\\sample-cs-user", "Name": "sample-cs-user", "Prefix": "local", "PrefixedName": "local:sample-cs-user", "PrefixedUniversal": "local:{77a4cdda-12f2-4d83-aaff-8a3682d014cc}", "Type": 1, "Universal": "{77a4cdda-12f2-4d83-aaff-8a3682d014cc}" } ], "JwtMapping": { "GranteePrefixedUniversal": "local:{77a4cdda-12f2-4d83-aaff-8a3682d014cc}", "IdField": "sub", "IdMatch": "PDnW4ovpwjkhVWkGjxW4F5yZvmxEwGV7@clients", "IssuerUri": "https://dev-g55ca78eoi1f0w71.us.auth0.com/", "Name": "Example JWT mapping", "PurposeField": "aud", "PurposeMatch": "https://example.venafi.com/vedauth" }, "Result": 0, "Success": true }