• 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

User Authentication

Postman Collection
OpenAPI
POST

Authenticate user

Authenticates a user. Does not generate an SSO token. For SSO please take a look at the SSO token resource

Request

Query parameters

username

string

Request bodyapplication/json application/xml

the directory mapping to add to the application

link

Link

value

string

Responses

the operation succeeded and authenticated user details are retrieved

application/json application/xml

any

POST/rest/usermanagement/1/authentication
1 2 3 4 5 6 7 8 curl --request POST \ --url 'http://{baseurl}/rest/rest/usermanagement/1/authentication' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "link": null, "value": "hunter2" }'
200Response
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 46 47 { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser", "rel": "self" }, "name": "sampleuser", "password": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser", "rel": "edit" } }, "key": "557057:927441f1-cc92-4030-b633-8a2bbdf7136e", "active": true, "attributes": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "attribute": [ { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts", "rel": "self" }, "name": "invalidPasswordAttempts", "values": [ "0" ] }, { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "name": "requiresPasswordChange", "values": [ "false" ] } ] }, "first-name": "Sample", "last-name": "User", "display-name": "Sample User", "email": "sample@user.cool" }
POST

Notify user authenticated

Notifies Crowd that a user has logged into an application, using a method different than the default /authentication or /session resources. Does not initiate a SSO session. This allows to trigger side effects in Crowd, such as updating the user from the remote directory, or applying automatic group assignments

Request

Query parameters

username

string

Responses

the operation succeeded and notification was triggered

application/json application/xml

any

POST/rest/usermanagement/1/authentication/notify
1 2 3 curl --request POST \ --url 'http://{baseurl}/rest/rest/usermanagement/1/authentication/notify' \ --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 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user?username=sampleuser", "rel": "self" }, "name": "sampleuser", "password": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/password?username=sampleuser", "rel": "edit" } }, "key": "557057:927441f1-cc92-4030-b633-8a2bbdf7136e", "active": true, "attributes": { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "attribute": [ { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts", "rel": "self" }, "name": "invalidPasswordAttempts", "values": [ "0" ] }, { "link": { "href": "https://crowdserver/crowd/rest/usermanagement/1/user/attributes?username=sampleuser&attributename=invalidPasswordAttempts&attributename=requiresPasswordChange", "rel": "self" }, "name": "requiresPasswordChange", "values": [ "false" ] } ] }, "first-name": "Sample", "last-name": "User", "display-name": "Sample User", "email": "sample@user.cool" }

Rate this page: