NYnylas
IAM credentials

Create IAM credential

Changed on

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

Creates an api_key credential for an active principal. name and expires_at are required. expires_at is an integer Unix timestamp in seconds, measured from January 1, 1970 at 00:00:00 UTC. It must be after the current time and no more than 10 calendar years ahead. Store the secret securely: only this response includes it. Unknown fields and null values are rejected.

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

Request

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

Request body

namestring required

Descriptive workload name. Surrounding whitespace is removed.

status'active' | 'disabled'

Whether the principal or credential can authenticate.

expires_atinteger required

Required expiration as an integer number of seconds since the Unix epoch (January 1, 1970 at 00:00:00 UTC). For example, 1799193600 represents January 6, 2027 at 00:00:00 UTC. Use seconds, not milliseconds, an ISO 8601 string, or a duration. In JavaScript, use Math.floor(date.getTime() / 1000); in Python, use int(utc_datetime.timestamp()) with a timezone-aware UTC datetime. The value must be after the current time and no later than 10 calendar years from now. You can't change it after creation; create a replacement credential to use a different expiration.

Example request

{
  "name": "Support worker key",
  "expires_at": 1799193600
}

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,
    "secret": "<NYLAS_IAM_API_KEY>"
  }
}

Changes