Get Directory Service Details (2.0)

GET 
/v2.0/api/tenants/:tenant_id/directoryservices

Get directory service details of a tenant.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

Responses

200

Successful Operation

application/json

Schema

Schema

directory_tenant_id string

The directory tenant ID.

enabled boolean

The directory service enabled.

group_attributes DirectoryGroupAttribute

The directory group attributes.

email string

Possible values: [SAM_ACCOUNT_NAME, EMAIL, COMMON_NAME, DISTINGUISHED_NAME, USER_PRINCIPAL_NAME]

The email address values.

primary_name string

Possible values: [SAM_ACCOUNT_NAME, EMAIL, COMMON_NAME, DISTINGUISHED_NAME, USER_PRINCIPAL_NAME]

The primary name.

id string

The ID.

region string

Region of the tenant.

tags string[]

A information field that can be added to identify the directory service. Maximum 10 unique tags of length 1024 each are allowed.

user_attributes DirectoryUserAttribute

The directory user attributes.

alternate_username_1 string

Possible values: [SAM_ACCOUNT_NAME, EMAIL, COMMON_NAME, DISTINGUISHED_NAME, USER_PRINCIPAL_NAME]

Alternate Username_1

alternate_username_2 string

Possible values: [SAM_ACCOUNT_NAME, EMAIL, COMMON_NAME, DISTINGUISHED_NAME, USER_PRINCIPAL_NAME]

Alternate Username_2

alternate_username_3 string

Possible values: [SAM_ACCOUNT_NAME, EMAIL, COMMON_NAME, DISTINGUISHED_NAME, USER_PRINCIPAL_NAME]

Alternate Username_3

email string

Possible values: [SAM_ACCOUNT_NAME, EMAIL, COMMON_NAME, DISTINGUISHED_NAME, USER_PRINCIPAL_NAME]

Email

primary_name string

Possible values: [SAM_ACCOUNT_NAME, EMAIL, COMMON_NAME, DISTINGUISHED_NAME, USER_PRINCIPAL_NAME]

Primary Name

Example (from schema)

{
  "directory_tenant_id": "string",
  "enabled": true,
  "group_attributes": {
    "email": "SAM_ACCOUNT_NAME",
    "primary_name": "SAM_ACCOUNT_NAME"
  },
  "id": "string",
  "region": "string",
  "tags": [
    "string"
  ],
  "user_attributes": {
    "alternate_username_1": "SAM_ACCOUNT_NAME",
    "alternate_username_2": "SAM_ACCOUNT_NAME",
    "alternate_username_3": "SAM_ACCOUNT_NAME",
    "email": "SAM_ACCOUNT_NAME",
    "primary_name": "SAM_ACCOUNT_NAME"
  }
}

Loading...