<back to all web services
UsersActionsReq
Remote Management
The following routes are available for this service:| PUT | /keycloak/users/actions | Send a update account email to the user which contains a link the user can click to perform a set of required actions | |
|---|
UsersActionsReq Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| SessionId | form | string | Yes | The id of the REST session |
| UserId | form | string | No | Id of User To Send Email To |
| Lifespan | form | int | No | Number of seconds after which the generated token expires |
| Client_Id | form | string | No | Number of seconds after which the generated token expires |
| Redirect_Uri | form | string | No | Number of seconds after which the generated token expires |
| RequiredActions | form | List<string> | Yes | List of Actions to have the user perform |
RequestBase Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| SessionId | form | string | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
PUT /keycloak/users/actions HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UsersActionsReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.Keycloak.Request.Users">
<SessionId xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.Keycloak.Request">String</SessionId>
<Client_Id>String</Client_Id>
<Lifespan>0</Lifespan>
<Redirect_Uri>String</Redirect_Uri>
<RequiredActions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RequiredActions>
<UserId>String</UserId>
</UsersActionsReq>