Consumer

Set a consumer's token settings

Sets the token settings the body carries (a null field keeps its stored value), switches the consumer to secret-manager authentication and redeploys it.

put/apiops/projects/{projectName}/consumers/{consumerKey}/token-settings

Request

Path parameters

projectNamestring required
consumerKeystring required

Request body

grantType'CLIENT_CREDENTIALS' | 'PASSWORD'

Grant type for authentication

tokenNeverExpiresboolean

Whether token never expires

tokenExpiresInAmountinteger

Token expiration amount

tokenExpiresInUnit'MILLI_SECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS'

Token expiration unit

refreshTokenAllowedboolean

Whether refresh token is allowed

refreshTokenCountinteger

Refresh token count

refreshTokenExpiresInAmountinteger

Refresh token expiration amount

refreshTokenExpiresInUnit'MILLI_SECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS' | 'YEARS'

Refresh token expiration unit

allowUrlParametersboolean

Whether URL parameters are allowed

jwtSignatureAlgorithmstring

JWT signature algorithm

deletePreviousboolean

Whether to delete previous tokens

Response

OK

status'SUCCESS' | 'FAILURE'
resourceVersioninteger

Changes

No recorded changes to this operation across all 21 revisions of this API.