Developer
News and Updates
Get Support
Sign in
Developer
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
News and Updates
Get support
Sign in
Developer
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
News and Updates
Get support
Sign in
  • Account Management
  • Alias
  • Application
  • Application Admin
  • Application Licensing
  • Audit
  • Backup
  • Cookie Configuration
  • Directory
  • Directory Admin
  • Group Admin
  • Group Level Admin
  • Groups
  • Groups Membership
  • LDAP Connection Pool
  • Look and Feel
  • Mail Server
  • Remember Me
  • SAML Configuration
  • Search
  • Server Info
  • Sessions
  • Token
  • User Admin
  • User Authentication
  • Users
Server
Crowd Data Center / / REST API

Directory

Postman Collection
OpenAPI
Operations
POST/rest/directorymanagement/1/directory/testazureadPOST/rest/directorymanagement/1/directory/testazuread/{id}POST/rest/directorymanagement/1/directory/testcrowdPOST/rest/directorymanagement/1/directory/testcrowd/{id}POST/rest/directorymanagement/1/directory/testldapPOST/rest/directorymanagement/1/directory/testldap/{id}POST/rest/directorymanagement/1/directory/testsearchPOST/rest/directorymanagement/1/directory/testsearch/{id}
POST

Test Microsoft Entra ID connection

Tests connection to the specified Microsoft Entra ID

Forge and OAuth2 apps cannot access this REST resource.

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
1 2 3 4 5 6 7 8 9 10 11 12 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

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

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}
1 2 3 4 5 6 7 8 9 10 11 12 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

Forge and OAuth2 apps cannot access this REST resource.

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
1 2 3 4 5 6 7 8 9 10 11 12 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

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

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}
1 2 3 4 5 6 7 8 9 10 11 12 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

Forge and OAuth2 apps cannot access this REST resource.

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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 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

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

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}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 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

Forge and OAuth2 apps cannot access this REST resource.

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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 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

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

id

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}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 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" }'

Rate this page: