Download integrator.io 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 | GET | 204 | Disables a specific user’s account. |
/invite | POST | 201 | Invite a user to the account. |
Users API examples
GET /v1/Users HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Request URL: https://integrator.io/api/ashares
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" } ]
GET /v1/Users HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Request URL: https://integrator.io/api/ashares/••••••••••••••••••/disable
Sample response
Error : 404 {"errors":[{"code":"access_restricted","message":"The account which you are trying to access has not been shared with you."}]}
https://integrator.io/api/ashares/63•••••••••••••••••••9
Method: PUT
Success: 204
Request URL: https://integrator.io/api/ashares/••••••••••••••••••/disable
Sample request
{ "_id": "k3os•••••••••••••••••••23k, "email": "email@email.com", "accessLevel": "administrator",
"accountMFARequired": false,
...}
https://integrator.io/api/invite
Method: POST
Sample request
{ "_id": "k3os•••••••••••••••••••23k", "email": "email@email.com", "accessLevel": "administrator",
"accountMFARequired": false
...}
You cannot change the email address
https://integrator.io/api/ashares/<Id>
Method: POST
Sample request
{ "_id":"64••••••••••••••••••cf8", "email":"email@email.com", "accessLevel":"administrator", "integrationAccessLevel":[], "accountSSORequired":false, "accountMFARequired":false }
You cannot change the email address
Comments
1 comment
If you are doing this in postman, it should look like this:
GET https://api.integrator.io/v1/ashares
Please sign in to leave a comment.