Skip to content
Skip to main content
GET
https://api.us.nylas.com/v3/iam/principals/{principal_id}

Get IAM principal

Returns a principal's details.

Requires an IAM API key with the iam.principals.read permission. Application API keys and access tokens don't work.

Parameters

Path parameters

principal_id*string

The principal's ID.

Responses

request_idstring

The ID of the request.

dataobject
Example: {"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}
GEThttps://api.us.nylas.com/v3/iam/principals/{principal_id}

Paste the authorization token required for this endpoint.

principal_idrequiredstring

The principal's ID.