IAM credentials

Update IAM credential

Changed on

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.

patch/v3/iam/principals/{principal_id}/credentials/{credential_id}

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    HTTP bearer

Request body

namestring

Descriptive workload name. Surrounding whitespace is removed.

status'active' | 'disabled'

Whether the principal or credential can authenticate.

Example request

{
  "name": "Support worker key"
}

Response

OK

request_idstring

Request ID for troubleshooting.

Example response

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

Changes