Access Token Customization Web Hook (1.0.0)

Download OpenAPI specification:Download

A hook that is executed just before the authorization grant is created (authorization call, refresh token)

customize-access-token-web-hook

customize-access-token

This webhook is meant for Access Token customization that includes requested scopes reduction as well as adding additional custom claims to JWT formatted token.

Authorizations:

basicAuthbearerAuth

Request Body schema: application/json

	object (User)
required	object (Client)
scopes required	Array of strings The scopes that are requested for the authorization grant.
	object All available user-related claims.
required	object (ExecutionContext)
	object or null Hook context optional custom parameters, i.e. : 'on_behalf_of', 'on_behalf_of_type'

Responses

Request samples

Payload

Content type

application/json

{"user": {"id": "fb6239f6-2j3j-4jj5-997-092999923h"
},
"client": {"id": "ad731534-b319-4760-ac0e-31c872c6fb7c"
},
"scopes": ["sim_read",
"name",
"openid",
"read"
],
"userClaims": { },
"executionContext": {"ipAddress": "string",
"triggeredBy": ["/oauth/authorize",
"/oauth/token",
"/oauth/v1/token",
"/oauth/api/v1/token/introspect"
]
},
"contextCustomParams": {"property1": ["string"
],
"property2": ["string"
]
}
}

Response samples

200

Content type

application/json

{"removeScopes": ["sim_read",
"name"
],
"additionalClaims": {"basicClaim": "example value",
"complexClaim": {"userDefinedProperty1": "userDefinedValue1",
"userDefinedProperty2": "userDefinedValue2"
}
}
}