GET

Get applications

Returns a paged list of all applications

Request

Query parameters

start

integer

limit

integer

name

string

active

boolean

Responses

returns all application if the operation succeeded

application/json

any

GET/rest/admin/1.0/application
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/application' \ --header 'Accept: application/json'
GET

Get application by ID

Returns the application with the specified id

Request

Path parameters

applicationId

integer

Required

Responses

returned if the application was retrieved successfully

application/json

any

GET/rest/admin/1.0/application/{applicationId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/application/{applicationId}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "id": 1900, "name": "crowd", "description": "crowd-app", "type": "CROWD", "active": true, "aliasingEnabled": false, "lowercaseOutput": false, "aggregateMemberships": false, "cachedDirectoriesAuthenticationOrderOptimisation": true, "directoryMappings": null, "filteringUsersWithAccessEnabled": null, "filteringGroupsWithAccessEnabled": null }
PUT

Update application

Updates the specified application

Request

Path parameters

applicationId

integer

Required

Request bodyapplication/json

the application's configuration

active

boolean

aliasingEnabled

boolean

attributes

AttributeEntityList

description

string

directoryMappings

DirectoryMappingEntityList

id

integer

link

Link

lowercaseOutput

boolean

name

string

password

PasswordEntity

Responses

returned if the application was updated successfully

application/json

any

PUT/rest/admin/1.0/application/{applicationId}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 curl --request PUT \ --url 'http://{baseurl}/rest/rest/admin/1.0/application/{applicationId}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "id": 1900, "name": "crowd", "description": "crowd-app", "type": "CROWD", "active": true, "aliasingEnabled": false, "lowercaseOutput": false, "aggregateMemberships": false, "cachedDirectoriesAuthenticationOrderOptimisation": true, "directoryMappings": null, "filteringUsersWithAccessEnabled": null, "filteringGroupsWithAccessEnabled": null }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "id": 1900, "name": "crowd", "description": "crowd-app", "type": "CROWD", "active": true, "aliasingEnabled": false, "lowercaseOutput": false, "aggregateMemberships": false, "cachedDirectoriesAuthenticationOrderOptimisation": true, "directoryMappings": null, "filteringUsersWithAccessEnabled": null, "filteringGroupsWithAccessEnabled": null }
GET

Get access based synchronization

Returns the Current Filter Type for Access Based Synchronization for the given Application

Request

Path parameters

applicationId

integer

Required

Responses

returned if the current filter type was retrieved successfully

application/json

any

GET/rest/admin/1.0/application/{applicationId}/access-based-synchronization
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/application/{applicationId}/access-based-synchronization' \ --header 'Accept: application/json'
200Response
1 2 3 { "filterType": "NO_FILTERING" }
PUT

Update access based synchronization

Change the current Filter Type used for Access Based Synchronization for the given Application

Request

Path parameters

applicationId

integer

Required

Request bodyapplication/json

the entity containing the new filter value

filterType

string

Responses

returned if the current filter type was updated successfully

PUT/rest/admin/1.0/application/{applicationId}/access-based-synchronization
1 2 3 4 5 6 curl --request PUT \ --url 'http://{baseurl}/rest/rest/admin/1.0/application/{applicationId}/access-based-synchronization' \ --header 'Content-Type: application/json' \ --data '{ "filterType": "NO_FILTERING" }'
GET

Get directory mappings

The directory mappings of the specified application

Request

Path parameters

applicationId

integer

Required

Query parameters

start

integer

limit

integer

Responses

returned if the directory mappings were retrieved successfully

application/json

any

GET/rest/admin/1.0/application/{applicationId}/directory-mapping
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/application/{applicationId}/directory-mapping' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 { "values": [ { "id": 123, "name": "Internal directory", "authentication": { "allowAll": false, "allowGroups": [ "crowd-administrators" ] }, "defaultGroups": [ "crowd-users" ] } ], "size": 1, "start": 2, "limit": 1, "isLastPage": false }
POST

Add directory mapping

Adds a directory mapping to the specified application. It is added as the last mapping for the application

Request

Path parameters

applicationId

integer

Required

Request bodyapplication/json

the directory mapping to add to the application

authentication

DirectoryMappingAuthenticationEntity

defaultGroups

array<string>

id

integer

name

string

Responses

the mapping was successfully created

POST/rest/admin/1.0/application/{applicationId}/directory-mapping
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 curl --request POST \ --url 'http://{baseurl}/rest/rest/admin/1.0/application/{applicationId}/directory-mapping' \ --header 'Content-Type: application/json' \ --data '{ "id": 123, "name": null, "authentication": { "allowAll": false, "allowGroups": [ "crowd-administrators" ] }, "defaultGroups": [ "crowd-users" ] }'
GET

Get directory mapping

Returns the specified application's mapping to the specified directory

Request

Path parameters

applicationId

integer

Required
directoryId

integer

Required

Responses

returned if the application directory mapping was retrieved successfully

application/json

any

GET/rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "id": 123, "name": "Internal directory", "authentication": { "allowAll": false, "allowGroups": [ "crowd-administrators" ] }, "defaultGroups": [ "crowd-users" ] }
PUT

Update directory mapping

Updates the specified directory mapping. The fields specified will overwrite the current values. The unspecified fields will not be changed

Request

Path parameters

applicationId

integer

Required
directoryId

integer

Required

Request bodyapplication/json

the directory mapping to add to the application

authentication

DirectoryMappingAuthenticationEntity

defaultGroups

array<string>

id

integer

name

string

Responses

the mapping was successfully created

application/json

any

PUT/rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 curl --request PUT \ --url 'http://{baseurl}/rest/rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "id": 123, "name": null, "authentication": { "allowAll": false, "allowGroups": [ "crowd-administrators" ] }, "defaultGroups": [ "crowd-users" ] }'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 { "id": 123, "name": "Internal directory", "authentication": { "allowAll": false, "allowGroups": [ "crowd-administrators" ] }, "defaultGroups": [ "crowd-users" ] }
DEL

Delete directory mapping

Removes a directory mapping from an application

Request

Path parameters

applicationId

integer

Required
directoryId

integer

Required

Responses

the mapping was removed correctly

DEL/rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}'
POST

Reorder directory mappings

Changes the position of the specified application-directory mapping

Request

Path parameters

applicationId

integer

Required
directoryId

integer

Required

Request bodyapplication/json

the the directory mapping to add to the application

after

string

position

string

Responses

returned if the application-directory mapping was updated successfully

POST/rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}/move
1 2 3 4 5 6 7 curl --request POST \ --url 'http://{baseurl}/rest/rest/admin/1.0/application/{applicationId}/directory-mapping/{directoryId}/move' \ --header 'Content-Type: application/json' \ --data '{ "after": 131073, "position": 2 }'

Rate this page: