Update IAM credential - IAM Credentials - API Reference

PATCH

https://api.us.nylas.com/v3/iam/principals/{principal_id}/credentials/{credential_id}

Requires iam.credentials.update on an active principal bound to the authenticated organization. Authenticate with an active, unexpired IAM credential of type api_key. Application API keys (including legacy API keys) and provider OAuth tokens cannot authorize IAM management endpoints. Use an existing IAM credential with these permissions, or create your first management credential in the Dashboard.

Updates only name and/or status. Expiration, type, principal, and secret cannot be changed. Omitted fields stay unchanged. A disabled principal cannot reactivate a credential. Empty bodies, null values, and unknown fields are rejected.

IAM API KEY

Parameters

Path parameters

principal_id*string

ID of the principal in the authenticated organization.

credential_id*string

ID of the credential in the authenticated organization.

Request body

namestring

Descriptive workload name. Surrounding whitespace is removed.

Example: "Support worker key"

minLength: 1maxLength: 128

statusstring

Whether the principal or credential can authenticate.

activedisabled

Responses

request_idstring

Request ID for troubleshooting.

dataobject

Example:

{"id":"8Lp2QwVm4rT6sYxN0cDzB","principal_id":"9Xf3LmQa2rP7sTuV0wYzB","type":"api_key","name":"Support worker key","status":"active","expires_at":1799193600,"created_at":1791417600,"updated_at":1791417600}

curl --request PATCH \ --url "https://api.us.nylas.com/v3/iam/principals/${NYLAS_PRINCIPAL_ID}/credentials/${NYLAS_CREDENTIAL_ID}" \ --header "Authorization: Bearer $NYLAS_IAM_ADMIN_KEY" \ --header "Content-Type: application/json" \ --data '{"status": "disabled"}'