Net3 API Interface for Customer Portal

<back to all web services

UsersAddReq

Remote Management

Requires Authentication
The following routes are available for this service:
POST/keycloak/users/addadd a user in keycloak
UsersAddReq Parameters:
NameParameterData TypeRequiredDescription
SessionIdformstringYesThe id of the REST session
GroupsformstringNoComma seperated list of groups the user is a member of
UsernameformstringYesThe username of the user
EmailformstringYesThe email must be unique
LastNameformstringYesThe last name of the user
FirstNameformstringYesThe first name of the user
UserIdformGuidNoThe user id in the logins database the user is associated with
CompanyIdformGuidNoThe company id in the logins database the user is associated with
RequiredActionsformList<string>NoA list of required actions to be performed on the user when created
EnabledformboolNoSet to true to enable user
RequestBase Parameters:
NameParameterData TypeRequiredDescription
SessionIdformstringNo

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>