IAM credentials

List IAM credentials

Changed on

Requires iam.credentials.read 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.

Never returns the credential secret.

Use next_cursor from the response as page_token on the next request. When next_cursor is absent, there are no more results.

get/v3/iam/principals/{principal_id}/credentials

Request

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

Query parameters

limitinteger

Maximum results per page.

page_tokenstring

Opaque next_cursor from the previous response.

Response

OK

request_idstring

Request ID for troubleshooting.

next_cursorstring

Opaque cursor. Absent on the final page. Pass as page_token.

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