Credential

Set Token Settings for Credential

Changed on

Sets token settings for credential specified by username and deploys it to environments

put/apiops/projects/{projectName}/credentials/{username}/token/

Request

Path parameters

projectNamestring required
usernamestring 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

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultListstring[]
resultCountinteger
unresolvedReferencesstring[]

Changes

    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from object to string

    • breaking

      the request property format changed from no format to int32

    • breaking

      the request property format changed from no format to int64

    • breaking

      the request property type changed from object to string

    • breaking

      the request property format changed from no format to int64

    • breaking

      the request property type changed from object to string

    This list may be incomplete.

    • info

      endpoint added