POST OAuth/UpdateJwtMapping

Updates an existing OAuth JWT mapping.

UpdateJwtMapping must express the complete configuration as desired. All fields in the structure will be stored when the request is received. If they are not set in the request, they will be defaulted.

A best practice is to get the current configuration using GetJwtMapping, modify that response as desired, and then pass the entire structure into the UpdateJwtMapping request.

Requirements

Roles: Admin. 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

Body parameters
Name	Description
JwtMapping object	(Required) Pass the following values: Name (string): The name of the application to update IssuerUri (string): The Issuer URI to be trusted for this mapping PurposeField (string): The name of the JWT field indicating the purpose PurposeMatch (string): The value the purpose field must have to accept a token IdField (string): The name of the JWT field indicating the identity owning the token IdMatch (string): The regular expression to apply against the id field to obtain the identity. If no GranteePrefixedUniversal is specified, the first group matching the expression is used to determine the identity GranteePrefixedUniversal (string): `null` if IdMatch is an expression returning a group. Otherwise the prefixed universal identity to use for a token issued against this mapping

Returns

Response description
Name	Description
HTTP 200	See OAuth result codes.
HTTP 400	For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body: Error invalid_request: The request is missing a required parameter or is otherwise malformed. Error_description: If available, additional information about how to retry the request.
HTTP 401	For authentication errors, this call returns HTTP 401 Unauthorized and the following data in the message body: Error invalid_token: The access token is missing, or the provided token is expired, revoked, malformed, or invalid for other reasons. insufficient_rights: The underlying user account does not have sufficient permissions for this request. error_description: If available, additional information about how to retry the request.
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. Error insufficient_scope: The request requires a greater scope than provided by the access token. error_description: If available, additional information about how to retry the request.

Examples

Request

POST /vedsdk/oauth/CreateJwtMapping HTTP/1.1
Host: tpp-server-url
Content-Type: application/json
Accept: application/json
Authorization: Bearer 4MyGeneratedBearerTknz==


{
  "JwtMapping": {
    "Name": "Example JWT mapping",
    "IdField": "sub",
    "IdMatch": "PDnW4ovpwjkhVWkGjxW4F5yZvmxEwGV7@clients",
    "IssuerUri": "https:\\/\\/dev-g55ca78eoi1f0w71.us.auth0.com\\/",
    "PurposeField": "aud",
    "PurposeMatch": "https:\\/\\/example.venafi.com\\/vedauth",
    "GranteePrefixedUniversal": "local:{77a4cdda-12f2-4d83-aaff-8a3682d014cc}"
  }
}

Response

{
  "Result": 0,
  "Success": true
}