Active-Directory - Flexible Secure Gateway API References (1.10.0)

Download OpenAPI specification:Download

Active-Directory resource.

Authentication

X-Auth-Token

Security Scheme Type	API Key
Header parameter name:	{keystone_token}

active-directory

Get ActiveDirectories

Get Active-Directory resources.

Authorizations:

X-Auth-Token

query Parameters

id	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the resource.
cellGroupId	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The Cell-Group ID which the resource belongs.
_limit	integer >= 1 The maximum number of items to return.
_offset	integer >= 0 The number of items to skip before starting to return results.
_order_by	Array of strings Items Enum: "id" "domain" "baseDn" "bindDn" "cellGroupId" "tenantId" "createdAt" "updatedAt" Sort keys.

header Parameters

X-Auth-Token

required

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

get/v1/active-directories

https://api.ntt.com/dsigw-erg/v1/active-directories

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"activeDirectories": 
[
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"domain": "ad-test",
"baseDn": "DC=ad-test, DC=example, DC=com",
"bindDn": "CN=aduser, CN=Users, DC=ad-test, DC=example, DC=com",
"servers": 
[
{"ipAddress": "192.0.2.1",
"port": 389
}
],
"securityGroups": 
["CN=group1,DC=ad-test1,DC=example,DC=com"
],
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z"
}
]
}

Create Active-Directory

Create an Active-Directory resource.

Authorizations:

X-Auth-Token

header Parameters

X-Auth-Token

string

The keystone token.

Request Body schema: application/json

activeDirectory

required

object (ActiveDirectoryCreateRequest)

Active-Directory create request schema.

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/v1/active-directories

https://api.ntt.com/dsigw-erg/v1/active-directories

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"activeDirectory": 
{"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"domain": "ad-test",
"baseDn": "DC=ad-test, DC=example, DC=com",
"bindDn": "CN=aduser, CN=Users, DC=ad-test, DC=example, DC=com",
"password": "password",
"servers": 
[
{"ipAddress": "192.0.2.1",
"port": 389
}
],
"securityGroups": 
["CN=group1,DC=ad-test1,DC=example,DC=com"
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"activeDirectory": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"domain": "ad-test",
"baseDn": "DC=ad-test, DC=example, DC=com",
"bindDn": "CN=aduser, CN=Users, DC=ad-test, DC=example, DC=com",
"servers": 
[
{"ipAddress": "192.0.2.1",
"port": 389
}
],
"securityGroups": 
["CN=group1,DC=ad-test1,DC=example,DC=com"
],
"operationId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z"
}
}

Get Active-Directory Details

Get an Active-Directory resource.

Authorizations:

X-Auth-Token

path Parameters

active_directory_id

required

string

The ID of the Active-Directory.

header Parameters

X-Auth-Token

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/v1/active-directories/{active_directory_id}

https://api.ntt.com/dsigw-erg/v1/active-directories/{active_directory_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"activeDirectory": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"domain": "ad-test",
"baseDn": "DC=ad-test, DC=example, DC=com",
"bindDn": "CN=aduser, CN=Users, DC=ad-test, DC=example, DC=com",
"servers": 
[
{"ipAddress": "192.0.2.1",
"port": 389
}
],
"securityGroups": 
["CN=group1,DC=ad-test1,DC=example,DC=com"
],
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z"
}
}

Update Active-Directory

Update an Active-Directory resource.

Authorizations:

X-Auth-Token

path Parameters

active_directory_id

required

string

The ID of the Active-Directory.

header Parameters

X-Auth-Token

string

The keystone token.

Request Body schema: application/json

activeDirectory

required

object (ActiveDirectoryUpdateRequest)

Active-Directory update request schema.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

patch/v1/active-directories/{active_directory_id}

https://api.ntt.com/dsigw-erg/v1/active-directories/{active_directory_id}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"activeDirectory": 
{"baseDn": "DC=ad-updated, DC=example, DC=com"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"activeDirectory": 
{"id": "2944a32f-3fb7-430e-9134-5eb611be23f6",
"cellGroupId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"domain": "ad-test",
"baseDn": "DC=ad-updated, DC=example, DC=com",
"bindDn": "CN=aduser, CN=Users, DC=ad-test, DC=example, DC=com",
"servers": 
[
{"ipAddress": "192.0.2.1",
"port": 389
}
],
"securityGroups": 
["CN=group1,DC=ad-test1,DC=example,DC=com"
],
"operationId": "047ae2a5-c763-4bea-9171-e178d08951ca",
"tenantId": "12345678abcdabcdabcd1234567890ab",
"createdAt": "2020-08-27T10:04:04Z",
"updatedAt": "2020-08-27T10:04:04Z"
}
}

Delete Active-Directory

Delete an Active-Directory resource.

Authorizations:

X-Auth-Token

path Parameters

active_directory_id

required

string

The ID of the Active-Directory.

header Parameters

X-Auth-Token

string

The keystone token.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/v1/active-directories/{active_directory_id}

https://api.ntt.com/dsigw-erg/v1/active-directories/{active_directory_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"errorCode": 400,
"errorMessage": "Invalid request",
"moreInfo": "{{moreInfo}}"
}