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

Application

Postman Collection
OpenAPI
GET

Get applications

Returns all the applications or a specific application by name

Forge and OAuth2 apps cannot access this REST resource.

Request

Query parameters

name

string

Responses

default response

application/json application/xml

any

GET/rest/appmanagement/1/application
1 2 curl --request GET \ --url 'http://{baseurl}/rest/rest/appmanagement/1/application'
POST

Add application

Adds a new application

Forge and OAuth2 apps cannot access this REST resource.

Request

Query parameters

include-request-address

boolean

Request bodyapplication/json application/xml

new application entity

active

boolean

aliasingEnabled

boolean

attributes

AttributeEntityList

description

string

directoryMappings

DirectoryMappingEntityList

id

integer

link

Link

lowercaseOutput

boolean

name

string

password

PasswordEntity

Responses

default response

application/json application/xml

any

POST/rest/appmanagement/1/application
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 40 41 42 43 44 45 curl --request POST \ --url 'http://{baseurl}/rest/rest/appmanagement/1/application' \ --header 'Content-Type: application/json' \ --data '{ "active": true, "aliasingEnabled": true, "attributes": { "callback": {}, "empty": true, "link": { "href": "<string>", "rel": "<string>" } }, "description": "<string>", "directoryMappings": { "empty": true, "link": { "href": "<string>", "rel": "<string>" } }, "id": 2154, "link": { "href": "<string>", "rel": "<string>" }, "lowercaseOutput": true, "name": "<string>", "password": { "link": { "href": "<string>", "rel": "<string>" }, "value": "<string>" }, "remoteAddresses": { "empty": true, "link": { "href": "<string>", "rel": "<string>" } }, "type": "<string>" }'
GET

Get application by ID

Returns the specified application

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

applicationId

integer

Required

Responses

default response

application/json application/xml

any

GET/rest/appmanagement/1/application/{applicationId}
1 2 curl --request GET \ --url 'http://{baseurl}/rest/rest/appmanagement/1/application/{applicationId}'
PUT

Update application

Updates the specified application

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

applicationId

integer

Required

Request bodyapplication/json application/xml

new application entity

active

boolean

aliasingEnabled

boolean

attributes

AttributeEntityList

description

string

directoryMappings

DirectoryMappingEntityList

id

integer

link

Link

lowercaseOutput

boolean

name

string

password

PasswordEntity

Responses

default response

application/json application/xml

any

PUT/rest/appmanagement/1/application/{applicationId}
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 40 41 42 43 44 45 curl --request PUT \ --url 'http://{baseurl}/rest/rest/appmanagement/1/application/{applicationId}' \ --header 'Content-Type: application/json' \ --data '{ "active": true, "aliasingEnabled": true, "attributes": { "callback": {}, "empty": true, "link": { "href": "<string>", "rel": "<string>" } }, "description": "<string>", "directoryMappings": { "empty": true, "link": { "href": "<string>", "rel": "<string>" } }, "id": 2154, "link": { "href": "<string>", "rel": "<string>" }, "lowercaseOutput": true, "name": "<string>", "password": { "link": { "href": "<string>", "rel": "<string>" }, "value": "<string>" }, "remoteAddresses": { "empty": true, "link": { "href": "<string>", "rel": "<string>" } }, "type": "<string>" }'
DEL

Delete application

Removes the specified application

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

applicationId

integer

Required

Responses

default response

application/json application/xml

any

DEL/rest/appmanagement/1/application/{applicationId}
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/rest/appmanagement/1/application/{applicationId}'
GET

Get remote addresses

Returns the remote addresses of the specified application

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

applicationId

integer

Required

Responses

default response

application/json application/xml

any

GET/rest/appmanagement/1/application/{applicationId}/remote_address
1 2 curl --request GET \ --url 'http://{baseurl}/rest/rest/appmanagement/1/application/{applicationId}/remote_address'
POST

Add remote address

Adds the remote address to the specified application

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

applicationId

integer

Required

Request bodyapplication/json application/xml

remote address entity

link

Link

value

string

Responses

default response

application/json application/xml

any

POST/rest/appmanagement/1/application/{applicationId}/remote_address
1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'http://{baseurl}/rest/rest/appmanagement/1/application/{applicationId}/remote_address' \ --header 'Content-Type: application/json' \ --data '{ "link": { "href": "<string>", "rel": "<string>" }, "value": "<string>" }'
DEL

Remove remote address

Removes the remote address of the specified application

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

applicationId

integer

Required

Query parameters

address

string

Responses

default response

application/json application/xml

any

DEL/rest/appmanagement/1/application/{applicationId}/remote_address
1 2 curl --request DELETE \ --url 'http://{baseurl}/rest/rest/appmanagement/1/application/{applicationId}/remote_address'

Rate this page: