Skip to main content
POST
https://{teamSlug}.teams.auth0.com
/
api
/
members
Invite a new team member
curl --request POST \
  --url https://{teamSlug}.teams.auth0.com/api/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "role": "teams_owner",
  "tenant_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "tenant_roles": [
    "owner"
  ],
  "client_ids": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "email": "jsmith@example.com",
  "role": "teams_owner",
  "tenant_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "tenant_roles": [
    "owner"
  ],
  "client_ids": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs-dev.auth0-mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Invite a new team member

email
string<email>
required

The email of the team member

Example:

"jane.smith@company.com"

role
enum<string>
required

The role of the team member

Available options:
teams_owner,
teams_contributor,
teams_report_viewer
Example:

"teams_owner"

tenant_ids
string<uuid>[]

Specifies an optional list of tenant IDs and their corresponding role assignments.

Unique identifier of the tenant

tenant_roles
enum<string>[]

The list of roles for each tenant.

Tenant Member Role

Available options:
owner,
editor-connections,
editor-users,
editor-specific-apps,
editor-organizations,
viewer-config,
viewer-users,
support-access,
elevated-support-access,
editor-kms
client_ids
string[]

The list of apps the user has access to for the 'editor-specific-apps' role. This property is only present for this role.

Required string length: 5 - 50
Pattern: ^([0-9a-zA-Z-_@\.~]{5,64})$
Example:
["client_123", "client_456"]

Response

Team member invited

id
string
required

The unique ID of the newly created team member

Example:

"invite_abc123"

email
string<email>
required

The email of the team member

Example:

"jane.smith@company.com"

role
enum<string>
required

The role of the team member

Available options:
teams_owner,
teams_contributor,
teams_report_viewer
Example:

"teams_owner"

tenant_ids
string<uuid>[]

The list of tenants granted to the team member

Unique identifier of the tenant

tenant_roles
enum<string>[]

The list the roles granted to the team member for each tenant

Tenant Member Role

Available options:
owner,
editor-connections,
editor-users,
editor-specific-apps,
editor-organizations,
viewer-config,
viewer-users,
support-access,
elevated-support-access,
editor-kms
client_ids
string[]

The list of apps the user has access to under the editor-specific-apps role.

Required string length: 5 - 50
Pattern: ^([0-9a-zA-Z-_@\.~]{5,64})$
Example:
["client_123", "client_456"]