Page History
...
As a GET endpoint, there is no body, so JSON parameters are not required in the message body.
GET Endpoint | Example |
---|---|
/users/{userId} | https://secureauth.company.com/secureauth2/api/v1/users/jdoe |
UI Expand | ||
---|---|---|
| ||
WebAdmin Configuration:
Profile data edits:
|
...
The /users PUT / POST endpoints add, update, or delete end user profile properties. SecureAuth IdP updates the user's profile by using the username in the endpoint URL.
PUT / POST Endpoint | Example |
---|---|
/users/{userId} | https://secureauth.company.com/secureauth2/api/v1/users/jdoe |
UI Expand | ||
---|---|---|
| ||
|
...
The /users POST user endpoint creates the new end user profile, so a username is not specified in the endpoint URL
POST Endpoint | Example |
---|---|
/users/ | https://secureauth.company.com/secureauth2/api/v1/users/ |
UI Expand | ||
---|---|---|
| ||
|
...
The /users POST resetpwd endpoint performs an administrative password reset for the end user. SecureAuth IdP accesses the end user's profile, resets the user's password, and provides a new password by using the username in the endpoint URL.
POST Endpoint | Example |
---|---|
/users/{userId}/resetpwd | https://secureauth.company.com/secureauth2/api/v1/users/jdoe/resetpwd |
UI Expand | ||
---|---|---|
| ||
|
...
The /users POST changepwd endpoint performs a password reset for the end user. SecureAuth IdP accesses the end user's profile and lets the end user change that password by using the username in the endpoint URL.
POST Endpoint | Example |
---|---|
/users/{userId}/changepwd | https://secureauth.company.com/secureauth2/api/v1/users/jdoe/changepwd |
UI Expand | ||
---|---|---|
| ||
|
...
No message body is required because all parameters for this request are present in the call URL.
POST Endpoint | Example |
---|---|
/users/{userId}/groups/{groupID to associate} | https://secureauth.company.com/secureauth2/api/v1/users/jdoe/groups/admins |
Result: userID "jdoe" is associated with the groupID "admins"
...
If any of the userIDs fail to POST, a failure response is generated that lists each userID that failed. userIDs not listed in the failure response successfully POSTed.
POST Endpoint | Example |
---|---|
/users/{userId}/groups/{groupId}/users | https://secureauth.company.com/secureauth2/api/v1/groups/Sharepoint%20Visitors/users |
Result: group "Sharepoint Visitors" is associated with the list of users specified in the message body
...
No message body is required because all parameters for this request are present in the call URL.
POST Endpoint | Example |
---|---|
/groups/{groupID}/users/{userID to associate} | https://secureauth.company.com/secureauth2/api/v1/groups/admins/users/jdoe |
Result: groupID "admins" is associated with userID "jdoe"
...
If any of the groupIDs fail to POST, a failure response is generated that lists each groupID that failed. groupIDs not listed in the failure response successfully POSTed.
POST Endpoint | Example |
---|---|
/users/{userId}/groups | https://secureauth.company.com/secureauth2/api/v1/users/jdoe/groups |
Result: user "jdoe" is associated with a list of groups specified in the message body
...