User

Varsha Neelesh
Varsha Neelesh
  • Updated

Create User

Creates a new user for instances in a subscription.

Request

Headers

 Name
 Type
 Required
syncariId

Id of the instance the api is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Body

 Name
 Type
 Required
email
string
required-table (1).svg
firstName
string
required-table (1).svg
lastName
string
required-table (1).svg
isApiUser
boolean
Default : false
userRoles
object
required-table (1).svg

Example

Request Sample

curl --request POST \
  --url https://api.syncari.com/api/v1/users \
  --header 'Accept: application/json' \
  --header 'Authorization: 1234' \
  --header 'Content-Type: application/json' \
  --header 'clientRequestId: ' \
  --header 'syncariId: ' \
  --data '{
  "email": "newuser@syncari.com",
  "firstName": "New",
  "lastName": "User",
  "isApiUser": true,
  "userRoles": {
    "YUBV99": [
      "Sync Manager",
      "Org Admin",
      "Instance Admin",
      "Viewer"
    ],
    "RR0VPW": [
      "Sync Manager",
      "Org Admin",
      "Instance Admin",
      "Viewer"
    ]
  }
}'

Response Sample

{
  "success": true,
  "requestId": "3816747063",
  "timestamp": "2022-05-09T04:58:37.744257Z",
  "result": {
    "id": "62789f7daa9138df5bc688f5",
    "createdBy": "61e2a0f134a0f06932046bab",
    "createdAt": "2022-05-09T04:58:37.259+00:00",
    "updatedBy": "61e2a0f134a0f06932046bab",
    "updatedAt": "2022-05-09T04:58:37.653+00:00",
    "email": "newuser@syncari.com",
    "status": "ACTIVE",
    "firstName": "New",
    "lastName": "User",
    "clientId": "Scb_pimGAcN4CLOvmaSyBuH0Udw",
    "clientSecret": "LXBCd4PXLH_9Mp9tBRRjxPDz0aFCH8_SiEW8V6Ena-o",
    "userRoles": {
      "RR0VPW": [
        "Sync Manager",
        "Org Admin",
        "Instance Admin",
        "Viewer"
      ],
      "YUBV99": [
        "Sync Manager",
        "Org Admin",
        "Instance Admin",
        "Viewer"
      ]
    },
    "apiUser": true
  }
}
Share this

Was this article helpful?

0 out of 0 found this helpful