<back to all web services
UsersAddReq
Remote Management
The following routes are available for this service:POST | /keycloak/users/add | add a user in keycloak | |
---|
UsersAddReq Parameters:Name | Parameter | Data Type | Required | Description |
---|
SessionId | form | string | Yes | The id of the REST session |
Groups | form | string | No | Comma seperated list of groups the user is a member of |
Username | form | string | Yes | The username of the user |
Email | form | string | Yes | The email must be unique |
LastName | form | string | Yes | The last name of the user |
FirstName | form | string | Yes | The first name of the user |
UserId | form | Guid | No | The user id in the logins database the user is associated with |
CompanyId | form | Guid | No | The company id in the logins database the user is associated with |
RequiredActions | form | List<string> | No | A list of required actions to be performed on the user when created |
Enabled | form | bool | No | Set to true to enable user |
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.
POST /keycloak/users/add HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UsersAddReq 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>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Email>String</Email>
<Enabled>false</Enabled>
<FirstName>String</FirstName>
<Groups>String</Groups>
<LastName>String</LastName>
<RequiredActions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RequiredActions>
<UserId>00000000-0000-0000-0000-000000000000</UserId>
<Username>String</Username>
</UsersAddReq>