Create Directory

Create Directory

Create an identity store. Http status 400 will be returned if an IdentityStore with the given domain exist for the target tenant.

Request

URI

POST

https://{api_host}/identity/api/tenants/{tenantId}/directories

COPY

Path Parameters

string

tenantId

Required

the target tenant id for the provided identity store

Request Body

the identity store to create

NOTE the fields ~~groupBaseSearchDn~~ and ~~userBaseSearchDn~~ are superseded by the corresponding array fields groupBaseSearchDns and userBaseSearchDns and thus deprecated, any value set to those fields will be ignored

directory of type(s) application/json

Required

{
    "domainAdminPassword": "string",
    "userObjectQuery": "string",
    "groupBaseSearchDn": "string",
    "certificate": "string",
    "description": "string",
    "type": "string",
    "subdomains": [
        "string"
    ],
    "password": "string",
    "bindUserObjectQuery": "string",
    "alias": "string",
    "customDirectorySearchAttribute": "string",
    "new": false,
    "groupObjectQuery": "string",
    "domainAdminUsername": "string",
    "trustAll": false,
    "url": "string",
    "membershipAttribute": "string",
    "userNameDn": "string",
    "groupBaseSearchDns": [
        "string"
    ],
    "distinguishedNameAttribute": "string",
    "userBaseSearchDn": "string",
    "customDirectorySearchAttributeForGroups": "string",
    "domain": "string",
    "name": "string",
    "userBaseSearchDns": [
        "string"
    ],
    "useGlobalCatalog": false,
    "objectUuidAttribute": "string"
}

string

domainAdminPassword

Optional

domainAdminPassword

string

userObjectQuery

Optional

userObjectQuery

string

groupBaseSearchDn

Optional

groupBaseSearchDn

string

certificate

Optional

certificate

string

description

Optional

description

string

type

Required

type

Possible values are : LDAP, AD, NATIVE_AD, LOCAL_DIRECTORY,

array of string

subdomains

Optional

subdomains

string

password

Required

password

string

bindUserObjectQuery

Optional

bindUserObjectQuery

string

alias

Optional

alias

string

customDirectorySearchAttribute

Optional

customDirectorySearchAttribute

boolean

new

Optional

new

string

groupObjectQuery

Optional

groupObjectQuery

string

domainAdminUsername

Optional

domainAdminUsername

boolean

trustAll

Optional

trustAll

string

url

Required

url

string

membershipAttribute

Optional

membershipAttribute

string

userNameDn

Required

userNameDn

array of string

groupBaseSearchDns

Optional

groupBaseSearchDns

string

distinguishedNameAttribute

Optional

distinguishedNameAttribute

string

userBaseSearchDn

Optional

userBaseSearchDn

string

customDirectorySearchAttributeForGroups

Optional

customDirectorySearchAttributeForGroups

string

domain

Required

domain

string

name

Required

name

array of string

userBaseSearchDns

Optional

userBaseSearchDns

boolean

useGlobalCatalog

Optional

useGlobalCatalog

string

objectUuidAttribute

Optional

objectUuidAttribute

Responses

200

successful operation

Returns directory of type(s) */*

{
    "domainAdminPassword": "string",
    "userObjectQuery": "string",
    "groupBaseSearchDn": "string",
    "certificate": "string",
    "description": "string",
    "type": "string",
    "subdomains": [
        "string"
    ],
    "password": "string",
    "bindUserObjectQuery": "string",
    "alias": "string",
    "customDirectorySearchAttribute": "string",
    "new": false,
    "groupObjectQuery": "string",
    "domainAdminUsername": "string",
    "trustAll": false,
    "url": "string",
    "membershipAttribute": "string",
    "userNameDn": "string",
    "groupBaseSearchDns": [
        "string"
    ],
    "distinguishedNameAttribute": "string",
    "userBaseSearchDn": "string",
    "customDirectorySearchAttributeForGroups": "string",
    "domain": "string",
    "name": "string",
    "userBaseSearchDns": [
        "string"
    ],
    "useGlobalCatalog": false,
    "objectUuidAttribute": "string"
}

string

domainAdminPassword

Optional

domainAdminPassword

string

userObjectQuery

Optional

userObjectQuery

string

groupBaseSearchDn

Optional

groupBaseSearchDn

string

certificate

Optional

certificate

string

description

Optional

description

string

type

Required

type

Possible values are : LDAP, AD, NATIVE_AD, LOCAL_DIRECTORY,

array of string

subdomains

Optional

subdomains

string

password

Required

password

string

bindUserObjectQuery

Optional

bindUserObjectQuery

string

alias

Optional

alias

string

customDirectorySearchAttribute

Optional

customDirectorySearchAttribute

boolean

new

Optional

new

string

groupObjectQuery

Optional

groupObjectQuery

string

domainAdminUsername

Optional

domainAdminUsername

boolean

trustAll

Optional

trustAll

string

url

Required

url

string

membershipAttribute

Optional

membershipAttribute

string

userNameDn

Required

userNameDn

array of string

groupBaseSearchDns

Optional

groupBaseSearchDns

string

distinguishedNameAttribute

Optional

distinguishedNameAttribute

string

userBaseSearchDn

Optional

userBaseSearchDn

string

customDirectorySearchAttributeForGroups

Optional

customDirectorySearchAttributeForGroups

string

domain

Required

domain

string

name

Required

name

array of string

userBaseSearchDns

Optional

userBaseSearchDns

boolean

useGlobalCatalog

Optional

useGlobalCatalog

string

objectUuidAttribute

Optional

objectUuidAttribute

201

creation is successful

Operation doesn't return any data structure

400

creation of identity store failed.

Operation doesn't return any data structure

On This Page

Request

Path Parameters

200 Response Body

201 Response Body

Errors

Api Operations

Add A permission To A role extension

Add A permission To admin permissions

Add A scope role To A principal In the context Of A scope

Add ACL To A tenant

Add scope role(s) To A principal

Add System Or Tenant role To A principal

Add users/grops To A parent group.

Add Business Group Roles

Add Empty Admin Permission

Add Empty Permission

Add Empty Role Permission

Add Empty Scope Type Admin Permission

Add Principals To Business Group Role

Add Resources To Scope

Add Role Permission

Add Scope Type Admin Permission

Check If A group exists.

Create A custom group

Create A local user.

Create Or update A principal extension

Create Business Group

Create Directory

Delete A custom group

Delete A local user.

Delete A permission from admin permissions

Delete A principal extension

Delete A SSO group from A custom group

Delete all principal extensions

Delete All Resources

Delete All Scopes

Delete Business Group

Delete Directory

Delete Resource

Deletes the UserTokenResource associated with the provided principal.

Deletes the UserTokenResource associated with the provided token id.

Find business groups Of A group

Find users In groups

Find Principals From Business Group Role

FindsXXX regular users In one Of the identity providers configured for the tenant.

Get password policy for the passed tenant

Get password state Of A local user

Get Business Group

Get Business Group Principal With Role

Get Business Group Roles

Get Business Groups

Get Directories

Get Effective Permissions For Principal

Get Permission Admin Permissions

Get Role Admin Permissions

Gets the group's advanced membership

Get User Business Groups

Register Or update relying party

Remove A permission from A role extension

Remove A user from A custom group

Remove ACL entries from A tenant

Remove An Scope role from A principal

Remove Business Group Role

Remove Empty Admin Permission

Remove Empty Permission

Remove Empty Principal Role

Remove Empty Scope Role For Principal

Remove Empty Scope Type Admin Permission

Remove Principal From Business Group Role

Remove Principal Role

Remove Resource From Scope

Remove Resources From Scope

Remove Role Empty Permission

Remove Role Permission

Remove Scope Type Admin Permission

Retrieve A group.

Retrieve the status Of An identity store

Retrieves all assigned custom groups and SSO groups.

Retrieves all custom groups and SSO groups.

Return A principal extension By Id

Return A specific scope for principal

Return ACL for A tenant

Return admin permission for A scope type

Return all parent groups

Return all permissions Of A role

Return business groups for A user

Return parent groups Of A user

Return permissions for principals

Return roles for principals

Return the effective roles for principal

Return the extended authorities for principals

Return the extended authorities permissions for principals

Return the extended authorities roles for principals

Return the permissions assigned To A role

Return the role extension assigned To A role

Return the roles To assign To other users

Return the scopes for principal

Return users By ids.

Return Busines Groups Principal Roles

Return Business Group Principals

Return Business Groups Principals

Return Principal Extensions

Return Principal From Scopes

Return Resource

Return Resources

Returns A page Of the resources

Returns A page Of the resources

Returns A page Of the resources

Returns A page Of the resources

Returns A page Of the resources

Returns A token associated with the provided credentials.

Returns A token matching the provided request details.

Returns the resource associated with the given Id

Returns the resource associated with the given Id

Returns the resource associated with the given Id

Returns the resource associated with the given Id

Returns the resource associated with the given Id

Returns the UserSecurityContext associated with the provided token id.

Set ACL Of A tenant

Set scope role(s) To A principal

Set System and Tenant roles(s) To A principal

Set Resources To Scope

Sets the group's advanced membership

Test the connectivity To An identity store

Update A custom group

Update A local user.

Update password policy for the passed tenant

Update service client secret

Update Business Group

Update Directory

Update Or Create Role Extension

Update Permission

Update Resource

Update Resource Type

Update Scope Type