Support for Server products ended Feb. 15, 2024. Learn what this means for you.

Server

Crowd Data Center / / REST API

Directory

Operations

POST/rest/directorymanagement/1/directory/testazuread POST/rest/directorymanagement/1/directory/testazuread/{id}POST/rest/directorymanagement/1/directory/testcrowd POST/rest/directorymanagement/1/directory/testcrowd/{id}POST/rest/directorymanagement/1/directory/testldap POST/rest/directorymanagement/1/directory/testldap/{id}POST/rest/directorymanagement/1/directory/testsearch POST/rest/directorymanagement/1/directory/testsearch/{id}

POST

Test Microsoft Entra ID connection

Tests connection to the specified Microsoft Entra ID

Request

Request bodyapplication/json

an entity with data required to connect to the Azure Active Directory

authorityEndpoint

string

graphEndpoint

string

nativeAppId

string

region

string

tenantId

string

webAppId

string

webAppSecret

string

Responses

returned if the connection was successfully made

POST/rest/directorymanagement/1/directory/testazuread

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/rest/directorymanagement/1/directory/testazuread' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantId": "example.onmicrosoft.com",
  "webAppId": "1a23b45c-de67-8ce0-881c-b43acfee0x34",
  "webAppSecret": "X70mv+pzvXoiib3OYwaRPVmzoFgq1eDpYUnGm0JTfzQ=",
  "nativeAppId": "a1af321g-j123-4ter-84x2-a456d3987aa1",
  "graphEndpoint": "https://graph.microsoft.com",
  "authorityEndpoint": "https://login.windows.net",
  "region": "GERMANY"
}'

POST

Test Microsoft Entra ID connection for directory

Tests connection to the specified Microsoft Entra ID. Should be used for existing directories

Request

Path parameters

integer

Required

Request bodyapplication/json

an entity with data required to connect to the Azure Active Directory

authorityEndpoint

string

graphEndpoint

string

nativeAppId

string

region

string

tenantId

string

webAppId

string

webAppSecret

string

Responses

returned if the connection was successfully made

POST/rest/directorymanagement/1/directory/testazuread/{id}

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/rest/directorymanagement/1/directory/testazuread/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
  "tenantId": "example.onmicrosoft.com",
  "webAppId": "1a23b45c-de67-8ce0-881c-b43acfee0x34",
  "webAppSecret": "X70mv+pzvXoiib3OYwaRPVmzoFgq1eDpYUnGm0JTfzQ=",
  "nativeAppId": "a1af321g-j123-4ter-84x2-a456d3987aa1",
  "graphEndpoint": "https://graph.microsoft.com",
  "authorityEndpoint": "https://login.windows.net",
  "region": "GERMANY"
}'

POST

Test Crowd connection

Tests connection to the specified Remote Crowd directory

Request

Request bodyapplication/json

an entity with data required to connect to the Remote Crowd directory

applicationName

string

applicationPassword

string

httpProxyHost

string

httpProxyPassword

string

httpProxyPort

integer

httpProxyUsername

string

url

string

Responses

returned if the connection was successfully made

POST/rest/directorymanagement/1/directory/testcrowd

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/rest/directorymanagement/1/directory/testcrowd' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "http://127.0.0.1:8095/crowd",
  "applicationName": "application",
  "applicationPassword": "application_password",
  "httpProxyHost": "",
  "httpProxyPort": null,
  "httpProxyUsername": "",
  "httpProxyPassword": ""
}'

POST

Test Crowd connection for directory

Tests connection to the specified Remote Crowd directory. Should be used for existing directories

Request

Path parameters

integer

Required

Request bodyapplication/json

an entity with data required to connect to the Remote Crowd directory

applicationName

string

applicationPassword

string

httpProxyHost

string

httpProxyPassword

string

httpProxyPort

integer

httpProxyUsername

string

url

string

Responses

returned if the connection was successfully made

POST/rest/directorymanagement/1/directory/testcrowd/{id}

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/rest/directorymanagement/1/directory/testcrowd/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "http://127.0.0.1:8095/crowd",
  "applicationName": "application",
  "applicationPassword": "application_password",
  "httpProxyHost": "",
  "httpProxyPort": null,
  "httpProxyUsername": "",
  "httpProxyPassword": ""
}'

POST

Test LDAP connection

Tests connection to the specified LDAP server

Request

Request bodyapplication/json

an entity with data required to connect to the server

baseDN

string

connector

string

groupDNaddition

string

groupDescriptionAttr

string

groupMemberAttr

string

groupNameAttr

string

groupObjectClass

string

groupObjectFilter

string

ldapPassword

string

referral

boolean

Responses

returned if the connection was successfully made

POST/rest/directorymanagement/1/directory/testldap

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/rest/directorymanagement/1/directory/testldap' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "ldap://localhost:389/",
  "secureMode": "NONE",
  "baseDN": "dc=test,dc=com",
  "ldapPassword": "admin",
  "userDN": "cn=admin,dc=test,dc=com",
  "connector": "com.atlassian.crowd.directory.OpenLDAP",
  "referral": false,
  "userEncryptionMethod": null,
  "groupDNaddition": null,
  "groupDescriptionAttr": null,
  "groupMemberAttr": null,
  "groupNameAttr": null,
  "groupObjectClass": null,
  "groupObjectFilter": null,
  "userDNaddition": null,
  "userObjectClass": null,
  "userGroupMemberAttr": null,
  "userFirstnameAttr": null,
  "userLastnameAttr": null,
  "userDisplayNameAttr": null,
  "userMailAttr": null,
  "userNameAttr": null,
  "userNameRdnAttr": null,
  "userPasswordAttr": null,
  "userObjectFilter": null,
  "userExternalIdAttr": null
}'

POST

Test LDAP connection for directory

Tests connection to the specified LDAP server. Should be used for existing directories

Request

Path parameters

integer

Required

Request bodyapplication/json

an entity with data required to connect to the server

baseDN

string

connector

string

groupDNaddition

string

groupDescriptionAttr

string

groupMemberAttr

string

groupNameAttr

string

groupObjectClass

string

groupObjectFilter

string

ldapPassword

string

referral

boolean

Responses

returned if the connection was successfully made

POST/rest/directorymanagement/1/directory/testldap/{id}

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/rest/directorymanagement/1/directory/testldap/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "ldap://localhost:389/",
  "secureMode": "NONE",
  "baseDN": "dc=test,dc=com",
  "ldapPassword": "admin",
  "userDN": "cn=admin,dc=test,dc=com",
  "connector": "com.atlassian.crowd.directory.OpenLDAP",
  "referral": false,
  "userEncryptionMethod": null,
  "groupDNaddition": null,
  "groupDescriptionAttr": null,
  "groupMemberAttr": null,
  "groupNameAttr": null,
  "groupObjectClass": null,
  "groupObjectFilter": null,
  "userDNaddition": null,
  "userObjectClass": null,
  "userGroupMemberAttr": null,
  "userFirstnameAttr": null,
  "userLastnameAttr": null,
  "userDisplayNameAttr": null,
  "userMailAttr": null,
  "userNameAttr": null,
  "userNameRdnAttr": null,
  "userPasswordAttr": null,
  "userObjectFilter": null,
  "userExternalIdAttr": null
}'

POST

Test LDAP search

Tests search with the provided LDAP directory configuration

Request

Request bodyapplication/json

an entity containing directory parameters

baseDN

string

connector

string

filterExpiredUsers

boolean

groupDNaddition

string

groupDescriptionAttr

string

groupMemberAttr

string

groupNameAttr

string

groupObjectClass

string

groupObjectFilter

string

ldapPassword

string

Responses

returned if the search was successful and returned results

POST/rest/directorymanagement/1/directory/testsearch

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/rest/directorymanagement/1/directory/testsearch' \
  --header 'Content-Type: application/json' \
  --data '{
  "strategy": "GROUP",
  "url": "ldap://localhost:389/",
  "secureMode": "NONE",
  "referral": false,
  "baseDN": "dc=test,dc=com",
  "userDN": "cn=admin,dc=test,dc=com",
  "ldapPassword": "admin",
  "userEncryptionMethod": null,
  "filterExpiredUsers": false,
  "primaryGroupSupport": false,
  "useUserMembershipAttribute": false,
  "useUserMembershipAttributeForGroupMembership": false,
  "useRelaxedDNStandardisation": false,
  "pagedResults": false,
  "pagedResultsSize": null,
  "groupDNaddition": null,
  "groupDescriptionAttr": null,
  "groupMemberAttr": null,
  "groupNameAttr": "cn",
  "groupObjectClass": null,
  "groupObjectFilter": "(objectCategory=Group)",
  "userDNaddition": null,
  "userObjectClass": null,
  "userGroupMemberAttr": null,
  "userFirstnameAttr": null,
  "userLastnameAttr": null,
  "userDisplayNameAttr": null,
  "userMailAttr": null,
  "userNameAttr": null,
  "userNameRdnAttr": null,
  "userPasswordAttr": null,
  "userObjectFilter": null,
  "userExternalIdAttr": null,
  "connector": "com.atlassian.crowd.directory.OpenLDAP"
}'

POST

Test LDAP search for directory

Tests search with the provided LDAP directory configuration. Should be used for existing directories

Request

Path parameters

integer

Required

Request bodyapplication/json

an entity containing directory parameters

baseDN

string

connector

string

filterExpiredUsers

boolean

groupDNaddition

string

groupDescriptionAttr

string

groupMemberAttr

string

groupNameAttr

string

groupObjectClass

string

groupObjectFilter

string

ldapPassword

string

Responses

returned if the search was successful and returned results

POST/rest/directorymanagement/1/directory/testsearch/{id}

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'http://{baseurl}/rest/rest/directorymanagement/1/directory/testsearch/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
  "strategy": "GROUP",
  "url": "ldap://localhost:389/",
  "secureMode": "NONE",
  "referral": false,
  "baseDN": "dc=test,dc=com",
  "userDN": "cn=admin,dc=test,dc=com",
  "ldapPassword": "admin",
  "userEncryptionMethod": null,
  "filterExpiredUsers": false,
  "primaryGroupSupport": false,
  "useUserMembershipAttribute": false,
  "useUserMembershipAttributeForGroupMembership": false,
  "useRelaxedDNStandardisation": false,
  "pagedResults": false,
  "pagedResultsSize": null,
  "groupDNaddition": null,
  "groupDescriptionAttr": null,
  "groupMemberAttr": null,
  "groupNameAttr": "cn",
  "groupObjectClass": null,
  "groupObjectFilter": "(objectCategory=Group)",
  "userDNaddition": null,
  "userObjectClass": null,
  "userGroupMemberAttr": null,
  "userFirstnameAttr": null,
  "userLastnameAttr": null,
  "userDisplayNameAttr": null,
  "userMailAttr": null,
  "userNameAttr": null,
  "userNameRdnAttr": null,
  "userPasswordAttr": null,
  "userObjectFilter": null,
  "userExternalIdAttr": null,
  "connector": "com.atlassian.crowd.directory.OpenLDAP"
}'