> ## Documentation Index
> Fetch the complete documentation index at: https://docs-dev-chore-teams-api-autoupdate.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# List a member's tenant access within an environment
> This endpoint retrieves a list of all tenants within a specific environment that the team member has access to. Environment identifiers required for this request can be obtained using the /api/environments endpoint, which provides details for all environments where tenants associated with your team exists.
export const Scopes = ({scopes = []}) => {
return
Scopes
{"Scopes define permissions and access levels for API requests and authentication tokens."}
;
};
## OpenAPI
````yaml teams-api-oas get /api/members/{id}/tenants/{environment}
openapi: 3.1.0
info:
contact: {}
title: Teams API
version: 1.0.0
description: >-
The Teams API provides programmatic access to manage team members, tenants,
environments, and activity logs for your Auth0 team.
servers:
- url: https://{teamSlug}.teams.auth0.com
description: The base URL for Teams API
variables:
teamSlug:
default: teamSlug
description: Team slug
security:
- Bearer: []
tags:
- name: Members
description: Operations related to team members
- name: Tenants
description: Operations related to tenants
- name: Environments
description: Operations related to environments
- name: Activity
description: Operations related to team activity logs
paths:
/api/members/{id}/tenants/{environment}:
get:
tags:
- Members
- Tenants
summary: List a member's tenant access within an environment
description: >-
This endpoint retrieves a list of all tenants within a specific
environment that the team member has access to. Environment identifiers
required for this request can be obtained using the /api/environments
endpoint, which provides details for all environments where tenants
associated with your team exists.
operationId: listTenantAccessByEnvironment
parameters:
- in: path
name: id
required: true
description: Unique ID of the team member.
schema:
type: string
- in: path
name: environment
required: true
description: The cloud environment identifier (e.g. 'US-3', 'EU-1', 'acme-dev').
schema:
type: string
minLength: 1
responses:
'200':
$ref: '#/components/responses/ListMembersTenantsResponse'
'400':
$ref: '#/components/responses/BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthorizedResponse'
'403':
$ref: '#/components/responses/ForbiddenResponse'
'404':
$ref: '#/components/responses/NotFoundResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
'500':
$ref: '#/components/responses/InternalServerErrorResponse'
security:
- Bearer:
- read:members
x-codeSamples: []
components:
responses:
ListMembersTenantsResponse:
description: Member tenant access list
content:
application/json:
schema:
$ref: '#/components/schemas/ListMembersTenantsResponseContent'
BadRequestResponse:
description: Invalid input based on schema.
content:
application/json:
schema:
type: object
properties:
status:
const: 400
type:
type: string
title:
type: string
details:
type: string
required:
- status
- type
- title
examples:
- status: 400
type: VALIDATION_ERROR
title: Invalid payload
UnauthorizedResponse:
description: Token has expired or signature is invalid.
content:
application/json:
schema:
type: object
properties:
status:
const: 401
type:
type: string
title:
type: string
details:
type: string
required:
- status
- type
- title
examples:
- status: 401
type: UNAUTHORIZED
title: Unauthorized
ForbiddenResponse:
description: Forbidden. The message will vary depending on the cause.
content:
application/json:
schema:
type: object
properties:
status:
const: 403
type:
type: string
title:
type: string
details:
type: string
required:
- status
- type
- title
examples:
- status: 403
type: TENANT_LIMIT_REACHED
title: You have reached the limit for tenants in your current plan
NotFoundResponse:
description: Not Found. The message will vary depending on the cause.
content:
application/json:
schema:
type: object
properties:
status:
const: 404
type:
type: string
title:
type: string
details:
type: string
required:
- status
- type
- title
examples:
- status: 404
type: TENANT_NOT_FOUND
title: The tenant was not found
TooManyRequestsResponse:
description: Too Many Requests. The message will vary depending on the cause.
content:
application/json:
schema:
type: object
properties:
status:
const: 429
type:
type: string
title:
type: string
details:
type: string
required:
- status
- type
- title
examples:
- status: 429
type: TOO_MANY_REQUESTS
title: Too many requests
InternalServerErrorResponse:
description: >-
Internal Server Error. The server encountered an unexpected condition
and could not fulfill the request.
content:
application/json:
schema:
type: object
properties:
status:
const: 500
type:
type: string
title:
type: string
details:
type: string
required:
- status
- type
- title
examples:
- status: 500
type: UNKNOWN_ERROR
title: An unknown error occurred
schemas:
ListMembersTenantsResponseContent:
type: object
properties:
environment:
type: string
description: The queried environment.
examples:
- US-3
- EU-1
- acme-dev
tenants:
type: array
description: Member tenant access list
items:
$ref: '#/components/schemas/MemberTenantItem'
required:
- environment
- tenants
MemberTenantItem:
type: object
properties:
tenant_id:
$ref: '#/components/schemas/TenantId'
domain:
$ref: '#/components/schemas/TenantFqdn'
roles:
type: array
description: An array of roles assigned to the team member within the tenant.
items:
$ref: '#/components/schemas/TenantRoleAssignment'
required:
- tenant_id
- domain
- roles
TenantId:
type: string
format: uuid
description: Unique identifier of the tenant
TenantFqdn:
type: string
description: >-
The fully qualified domain name of the tenant, which uniquely identifies
its domain within the system. The domain is used to define the audience
when interacting with the Management API, enabling programmatic
management of the tenant’s configuration and resources.
examples:
- acme-development-tenant.us.auth0.com
- acme-development-tenant.acme-dev.auth0app.com
TenantRoleAssignment:
type: object
properties:
role:
$ref: '#/components/schemas/TenantMemberRoleEnum'
description: The role assigned to the member.
client_ids:
type: array
items:
$ref: '#/components/schemas/ClientId'
description: >-
The list of apps the user has access to for the
'editor-specific-apps' role. This property is only present for this
role.
examples:
- - App-A
- App-B
required:
- role
additionalProperties: false
allOf:
- if:
properties:
role:
const: editor-specific-apps
then:
required:
- client_ids
TenantMemberRoleEnum:
type: string
description: Tenant Member Role
enum:
- owner
- editor-connections
- editor-users
- editor-specific-apps
- editor-organizations
- viewer-config
- viewer-users
- support-access
- elevated-support-access
- editor-kms
examples:
- owner
ClientId:
type: string
minLength: 5
maxLength: 50
pattern: ^([0-9a-zA-Z-_@\.~]{5,64})$
examples:
- x3qNvwb7BmNH4NMbLHqaN72OKNjDVGVg
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
````