Skip to navigation

Update M2M client

Updates name, description, scopes, or token expiry. Provide at least one field; unknown fields, including environment, are rejected with 400. The secret, environment, and authorization access cannot be changed here. New scopes must be registered, and a bearer caller may set only scopes its own token holds (403 PERMISSION_DENIED with details.exceedingScopes otherwise).

Requires every scope: m2m-clients:write.

Authentication

AuthorizationBearer

JWT returned by POST /api/auth/token-exchange. Amazon, authorization invitations, and developer credentials require API-key-derived tokens.

Path parameters

idintegerRequired1-2147483647

Numeric M2M client ID (the id field, not clientId).

Request

This endpoint expects an object.
namestringOptional>=1 character
descriptionstring or nullOptional
scopeslist of stringsOptional
Replaces the scope list. No broader than the caller's own token scopes.
expiryintegerOptional300-900
Access JWT lifetime in seconds.

Response

Success
m2mClientobject
M2M client metadata. The client secret is never included.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error