NYnylas
IAM principals

Get IAM principal

Changed on

Requires iam.principals.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.

get/v3/iam/principals/{principal_id}

Request

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

Response

OK

request_idstring

Request ID for troubleshooting.

Example response

{
  "data": {
    "id": "9Xf3LmQa2rP7sTuV0wYzB",
    "organization_id": "<NYLAS_ORGANIZATION_ID>",
    "name": "Support mailbox reader",
    "description": "Reads the support mailbox",
    "status": "active",
    "roles": [
      "role_system_messages_reader"
    ],
    "direct_permissions": [],
    "resource_binding": {
      "type": "grant",
      "id": "<NYLAS_GRANT_ID>"
    },
    "created_at": 1791417600,
    "updated_at": 1791417600
  }
}

Changes