• 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

SAML Configuration

Postman Collection
OpenAPI
GET

Get configuration

Returns the global SAML configuration

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

returned if global SAML configuration was successfully retrieved

application/json

any

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

Parse metadata

Parses application metadata.

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodyapplication/octet-stream

search criteria

object

Responses

returned if application SAML configuration was successfully retrieved

application/json

any

POST/rest/admin/1.0/samlconfig/application/parse_metadata
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/rest/admin/1.0/samlconfig/application/parse_metadata' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 { "entityId": "http://my.service.com", "assertionConsumerUrl": "http://my.service.com/SAML2/SSO/POST", "enabled": null, "nameIdFormat": "UNSPECIFIED", "addUserAttributesEnabled": false }
POST

Parse metadata file

Parses application metadata.

Forge and OAuth2 apps cannot access this REST resource.

Request

Request bodymultipart/form-data

search criteria

contentType

string

formField

boolean

inputStream

object

name

string

size

integer

value

string

Responses

returned if application SAML configuration was successfully retrieved

application/json

any

POST/rest/admin/1.0/samlconfig/application/parse_metadata_multipart
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/rest/admin/1.0/samlconfig/application/parse_metadata_multipart' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 { "entityId": "http://my.service.com", "assertionConsumerUrl": "http://my.service.com/SAML2/SSO/POST", "enabled": null, "nameIdFormat": "UNSPECIFIED", "addUserAttributesEnabled": false }
GET

Get application configuration

Returns SAML configuration

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

applicationId

integer

Required

Responses

returned if application SAML configuration was successfully retrieved

application/json

any

GET/rest/admin/1.0/samlconfig/application/{applicationId}
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/samlconfig/application/{applicationId}' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 { "entityId": "http://my.service.com", "assertionConsumerUrl": "http://my.service.com/SAML2/SSO/POST", "enabled": true, "nameIdFormat": "UNSPECIFIED", "addUserAttributesEnabled": false }
POST

Update application configuration

Updates SAML configuration for a specified application

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

applicationId

integer

Required

Request bodyapplication/json

Entity for application SAML configuration

addUserAttributesEnabled

boolean

assertionConsumerUrl

string

enabled

boolean

entityId

string

nameIdFormat

string

Responses

returned if application SAML configuration was successfully created

POST/rest/admin/1.0/samlconfig/application/{applicationId}
1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'http://{baseurl}/rest/rest/admin/1.0/samlconfig/application/{applicationId}' \ --header 'Content-Type: application/json' \ --data '{ "entityId": "http://my.service.com", "assertionConsumerUrl": "http://my.service.com/SAML2/SSO/POST", "enabled": true, "nameIdFormat": "UNSPECIFIED", "addUserAttributesEnabled": false }'
GET

Find directory mappings mismatch

Compares the directory mappings of application with crowd application

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

applicationId

integer

Required

Responses

returned if a mismatch is found

application/json

any

GET/rest/admin/1.0/samlconfig/application/{applicationId}/directory-mapping-mismatch
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/samlconfig/application/{applicationId}/directory-mapping-mismatch' \ --header 'Accept: application/json'
200Response
1 2 3 4 { "entity": null, "reason": "Directory mappings in Crowd and Jira are not same" }
GET

Get identity provider metadata

Returns Identity provider's metadata

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

returned if application SAML configuration was successfully retrieved

application/xml

any

GET/rest/admin/1.0/samlconfig/idp/metadata
1 2 3 curl --request GET \ --url 'http://{baseurl}/rest/rest/admin/1.0/samlconfig/idp/metadata' \ --header 'Accept: application/xml'
POST

Reset configuration

Replaces the private key/certificate pair used for signing/verifying assertions with a new one

Forge and OAuth2 apps cannot access this REST resource.

Request

This request has no parameters.

Responses

returned if replacing key/certificate pair and fetching SAML configuration succeeded

application/json

any

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

Rate this page: