NYnylas
IAM principals

List IAM principals

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.

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

Request

Query parameters

limitinteger

Maximum results per page.

page_tokenstring

Opaque next_cursor from the previous response.

resource_binding_type'organization' | 'application' | 'workspace' | 'grant'

Filter by binding type. Must be supplied with resource_binding_id.

resource_binding_idstring

Filter by binding ID. Must be supplied with resource_binding_type.

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": "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