Skip to content

Latest commit

 

History

History
526 lines (384 loc) · 14.2 KB

users.md

File metadata and controls

526 lines (384 loc) · 14.2 KB

User APIs

Get a user list
Get a user
Get a list of user groups the user belongs to
Create user
Update user
Get user permissions
Add user permission for a given resource
Update user permission for a given resource
Delete user permission

Get a user list

List all the users.

GET /api/v1/users

Path parameters

This request does not have any path parameters.

Query parameters

The query parameters are not expected.

Request body

The request body must be empty.

Response

The successful response contains an array of instances of User List Item.

The error response contains an Error.

Example

Request

curl https://app.solvexia.com/api/v1/users -X GET -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg"

Response

[
  {
    "id": "u-2345",
    "loginName": "template.mona.benson"
  },
  {
    "id": "u-23577",
    "loginName": "template.jill.watkin"
  }
]

Get a user

Returns a user at a given id.

GET /v1/users/{userId}

Path parameters

Name Type Description
userId string The id of a user to request.

Query parameters

The query parameters are not expected.

Request body

The request body must be empty.

Response body

The successful response contains an instance of a User.

The error response contains an Error.

Example

Request

curl https://app.solvexia.com/api/v1/users/u-11427 -X GET -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg"

Response

{
    "id": "u-11427",
    "firstName": "Mona",
    "lastName": "Benson",
    "loginName": "template.mona.benson",
    "email": "mona.benson@sample.com",
    "accountStatus": "Active",
    "city": "Sydney",
    "country": "Australia",
    "dateOfBirth": null,
    "department": null,
    "lastSignInDate": "2011-03-14T14:56:00.0000000",
    "phoneNumberLand": null,
    "phoneNumberMobile": null,
    "timezone": "(UTC+10:00) Canberra, Melbourne, Sydney",
    "userRole": "Designer"
}

Get a list of user groups the user belongs to

Returns a list of user groups the user belongs to.

GET /v1/users/{userId}/usergroups

Path parameters

Name Type Description
userId string The id of a user to request a list of groups for.

Query parameters

The query parameters are not expected.

Request body

The request body must be empty.

Response body

The successful response contains a list of User Group List Item.

The error response contains an Error.

Example

Request

curl https://app.solvexia.com/api/v1/users/u-11427/usergroups -X GET -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg"

Response

[
  {
    "id": "ug-4321",
    "name": "Marketing Team"
  },
  {
    "id": "ug-234987",
    "name": "Project Team"
  }
]

Create user

Create a user.

POST /v1/users

Path parameters

The path parameters are not expected.

Query parameters

The query parameters are not expected.

Request body

Name Type Description Required Example
email string The new user’s email. ☑ "email": "mona.benson@sample.com"
firstName string The new user’s first name. ☑ "firstName": "Mona"
lastName string The new user’s last name. ☑ "lastName": "Benson"
password string The new user’s password. Password length must be between 12 and 64 characters. If the password is not supplied the user will receive an email to set up their password. ☐ "password": "Samplepassword12"
userRole enum The new user’s role. ☑ "userRole": "Designer"
timezone enum The new user’s timezone. ☑ "timezone": "(UTC+10:00) Canberra, Melbourne, Sydney"

Example

{
    "email": "mona.benson@sample.com",
    "firstName": "Mona",
    "lastName": "Benson",
    "password": "Samplepassword12",
    "userRole": "Designer",
    "timezone": "(UTC+10:00) Canberra, Melbourne, Sydney"
}

Response body

The successful response contains an instance of a User.

The error response contains an Error.

Example

Request

curl "https:///app.solvexia.com/api/v1/users" -X POST -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg" -H "Content-Type: application/json" -d '{"email": "mona.benson@sample.com", "firstName": "Mona", "lastName": "Benson","password": "Samplepassword12","userRole": "Designer","timezone": "(UTC+10:00) Canberra, Melbourne, Sydney"}'

Response

{
    "id": "u-11427",
    "firstName": "Mona",
    "lastName": "Benson",
    "loginName": "template.mona.benson",
    "email": "mona.benson@sample.com",
    "accountStatus": "Active",
    "city": null,
    "country": null,
    "dateOfBirth": null,
    "department": null,
    "lastSignInDate": null,
    "phoneNumberLand": null,
    "phoneNumberMobile": null,
    "timezone": "(UTC+10:00) Canberra, Melbourne, Sydney",
    "userRole": "Designer"
}

Update user

Update a user.

POST /v1/users/{userId}

Path parameters

Name Type Description
userId string The user id to request.

Query parameters

The query parameters are not expected.

Request body

The request body contains a list of the User fields that can be updated.

Name Type Description Required Example
firstName string The user’s new first name. ☐ "firstName": "Jane"
lastName string The user’s new last name. ☐ "lastName": "Jordan"
email string The user’s new email. ☐ "email": "tom.jordan@sample.com"
accountStatus enum The user’s new Account Status. ☐ "accountStatus": "Suspended"
city string The user’s new city. ☐ "city": "Brisbane"
country string The user’s new country. ☐ "country": "New Zeland"
dateOfBirth string The user’s new dateOfBirth. The format needs to be in dd/MM/yyyy. ☐ "dateOfBirth": "19/09/1999"
department string The user’s new department. ☐ "department": "Marketing"
phoneNumberLand string The user’s new phoneNumberLand. ☐ "phoneNumberLand": "0281538412"
phoneNumberMobile string The user’s new phoneNumberMobile. ☐ "phoneNumberMobile": "0481538412"
timezone string The user’s new timezone. ☐ "timezone": "(UTC-10:00) Hawaii"
userRole string The user’s new role. ☐ "userRole": "Subscriber"

Example

{
    "lastName": "Jordan",
    "accountStatus": "Suspended",
    "email": "mona.jordan@sample.com"
}

Response body

The successful response contains an instance of a User.

The error response contains an Error.

Example

Request

curl "https:///app.solvexia.com/api/v1/users/u-11427" -X POST -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg" -H "Content-Type: application/json" -d '{"lastName": "Jordan", "accountStatus": "Suspended", "email": "tom.jordan@sample.com"}'

Response

{
    "id": "u-11427",
    "firstName": "Mona",
    "lastName": "Jordan",
    "loginName": "template.mona.benson",
    "email": "mona.jordan@sample.com",
    "accountStatus": "Suspended",
    "city": "Sydney",
    "country": "Australia",
    "dateOfBirth": null,
    "department": null,
    "lastSignInDate": "2011-03-14T14:56:00.0000000",
    "phoneNumberLand": null,
    "phoneNumberMobile": null,
    "timezone": "(UTC+10:00) Canberra, Melbourne, Sydney",
    "userRole": "Designer"
}

Get user permissions

Get a list of user permissions.

GET /v1/users/{userId}/permissions

Path parameters

Name Type Description
userId string The user id to request.

Query parameters

The query parameters are not expected.

Request body

The request body must be empty.

Response body

The successful response contains a list of Permission.

The error response contains an Error.

Example

Request

curl "https://app.solvexia.com/api/v1/users/u-11427/permisions" -X GET -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg"

Response

[
  {
    "resourceId": "p-2343",
    "resourceName": "Sales reconciliation",
    "role": "executor"
  },
  {
    "resourceId": "mt-4323",
    "resourceName": "Monthly Revenue",
    "role": "reader"
  }
]

Add user permission for a given resource

Add resource permission to the user.

POST /v1/users/{userId}/permissions

Path parameters

Name Type Description
userId string The user id to set up the permission for.

Query parameters

The query parameters are not expected.

Request body

Name Type Description Required Example
resourceId string The resource id to set up the new permission to. ☑ "resourceId": "p-2343"
role enum The user’s permission role for the resource. ☑ "role": "reader"

Example

{
  "resourceId": "p-2343",
  "role": "reader"
}

Response body

The successful response contains a Permission.

The error response contains an Error.

Example

Request

curl "https://app.solvexia.com/api/v1/users/u-11427/permisions" -X POST -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg" -H "Content-Type: application/json" -d '{"resourceId": "p-2343", "role": "reader"}'

Response

{
  "resourceId": "p-2343",
  "resourceName": "Sales reconciliation",
  "role": "reader"
}

Update user permission for a given resource

Update resource permission of the user.

POST /v1/users/{userId}/permissions/{resourceId}

Path parameters

Name Type Description
userId string The user id to update the permission for.
resourceId string The resource id to update with the new permission.

Query parameters

The query parameters are not expected.

Request body

Name Type Description Required Example
role enum The user’s permission role for the resource. ☑ "role": "reader"

Example

{
  "role": "editor"
}

Response body

The successful response contains a Permission.

The error response contains an Error.

Example

Request

curl "https://app.solvexia.com/api/v1/users/u-11427/permisions/p-2343" -X POST -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg" -H "Content-Type: application/json" -d '{"role": "editor"}'

Response

{
  "resourceId": "p-2343",
  "resourceName": "Sales reconciliation",
  "role": "editor"
}

Delete user permission

Delete resource permission of a user.

DELETE /v1/users/{userId}/permissions/{resourceId}

Path parameters

Name Type Description
userId string The user id to delete permission for.
resourceId string The resource id to delete permission for.

Query parameters

The query parameters are not expected.

Request body

The request body must be empty.

Response body

The response body is empty.

The error response contains an Error.

Example

Request

curl "https://app.solvexia.com/api/v1/users/u-11427/permisions/p-2343" -X DELETE -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg"

Response

200 OK