Articles in this section

Users API endpoints

Kathyana Queeman
Updated

download.svg​​ Download Postman collection

Users API endpoints

Relative URI

Method

Success code

Description

/ashares

GET

200

Retrieves the list of all users from your account along with their access level and other attributes.

/ashares/<id>

GET

200

Retrieves a specific user.

PUT

204

Update a specific user’s account.

DELETE

204

Deletes a specific user.

/ashares/<id>/disable

PUT

204

Disables or enables a specific user’s account.

/invite

POST

201

Invite a user to the account.

/invite/multiple

POST

201

Invite multiple users to an account.

/ashares/<id>/reinvite

PUT

204

Reshare the account access to a user.

/ssoclients/<id>

PATCH

204

Update a specific part of a user's SSO client.

There is one SSO client field you can update using a PATCH. You must use the provided format to update the field:

[
    {
        "op": "replace",
        "path": "/fieldname",
        "value": "newvalue"
    }
]

Field

Data type

disabled

boolean

Users API examples

Get Users

GET /v1/ashares HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample response

[

 {
      "_id":"554••••••••••••••••••00d",
      "accepted":true,
      "accessLevel":"manage",
      "integrationAccessLevel":
      [
          {
            "_integrationId":"554••••••••••••••••••00d8",
            "accessLevel":"manage"
         },
      ],
      "accountSSORequired":false,
      "lastModified":"2022-01-18T22:50:37.665Z",
      "sharedWithUser":{
         "_id":"554••••••••••••••••••00dj",
         "email":"youremail@domain.com",
         "name":"John Smith",
         "allowedToResetMFA":false,
         "accountSSOLinked":"not_linked"
   }

]

Disable or enable a user

This endpoint will enable or disable a user based on their current status in the platform. If a user is disabled, using this endpoint will automatically enable them (regardless of the endpoint name "disabled").

PUT /v1/ashares/63•••••••••••••••••••/disable HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Edit user

You cannot change the email address

PUT /v1/ashares/63•••••••••••••••••••9 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample request

{
"_id": "k3os•••••••••••••••••••23k,
"email": "email@email.com",
"accessLevel": "administrator",
"accountMFARequired": false,
...}

Invite user

POST /v1/invite HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample request

{   
"email": "user@user.com",   
"accessLevel": "administrator",
"integrationAccessLevel": [],   
"accountSSORequired": false,   
"accountMFARequired": true
}

Invite multiple users

POST /v1/invite/multiple HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample request

{   
"emails": [
       "email@email.com",
       "test@test.com"  
],   
"accessLevel": "administrator",
"integrationAccessLevel": [],   
"accountSSORequired": false,   
"accountMFARequired": true
}

Get a specific user

GET /v1/ashares/64••••••••••••••••••cf8 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample response

{
    "_id":"64••••••••••••••••••cf8",
    "email":"email@email.com",
    "accessLevel":"administrator",
    "integrationAccessLevel":[],
    "accountSSORequired":false,
    "accountMFARequired":false
    }