Skip to content

user_groups.md

Latest commit

 

History

History
454 lines (313 loc) · 9.9 KB

user_groups.md

File metadata and controls

454 lines (313 loc) · 9.9 KB

User Group APIs

Get a user group list
Get a user group
Get users for a user group
Add a user to a user group
Remove a user from a user group
Get user group permissions
Add user group permission for a given resource
Update user group permission for a given resource
Delete or update user group permission

Get a user group list

List all the user groups.

GET /api/v1/userGroups

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 Group List Item.

The error response contains an Error.

Example

Request

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

Response

[
  {
    "id": "ug-1234",
    "name": "Sales Team"
  },
  {
    "id": "ug-234987",
    "name": "Project Team"
  }
]

Get a user group

Returns a user group at a given id.

GET /v1/usergroups/{userGroupId}

Path parameters

Name Type Description
userGroupId string The id of a user group 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 UserGroup.

The error response contains an Error.

Example

Request

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

Response

{
    "id": "ug-114273",
    "name": "Sales Team",
    "description": "Description for a user group"
}

Get users for a user group

Get a list of members for a user group.

GET /v1/usergroups/{userGroupId}/users

Path parameters

Name Type Description
userGroupId string The user group 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 an array of instances of a User List Item.

The error response contains an Error.

Example

Request

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

Response

[
  {
    "id": "u-1233",
    "loginName": "template.tom.jordan"
  },
  {
    "id": "u-1463",
    "loginName": "template.jack.mayer"
  }
]

Add a user to a user group

Add a user to a user group.

POST /v1/usergroups/{userGroupId}/users

Path parameters

Name Type Description
userGroupId string The user group id to request.

Query parameters

The query parameters are not expected.

Request body

Name Type Description Required Example
id string The user id to add. ☑ "id": "u-1233"

Example

{
    "id": "u-1233"
}

Response body

The successful response contains a User List Item.

The error response contains an Error.

Example

Request

curl "https://app.solvexia.com/api/v1/usergroups/ug-114273/users/u-1233" -X POST -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg" -H "Content-Type: application/json" -d '{"id": "u-1234"}'

Response

{
  "id": "u-1233",
  "loginName": "template.tom.jordan"
}

Remove a user from a user group

Remove a user from a user group.

DELETE /v1/usergroups/{userGroupId}/users/{userId}

Path parameters

Name Type Description
userGroupId string The user group id to request.
userId string The user id to remove.

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/usergroups/ug-114273/users/u-1233" -X DELETE -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg"

Response

200 OK

Get user group permissions

Get a list of user group permissions.

GET /v1/usergroups/{userGroupId}/permissions

Path parameters

Name Type Description
userGroupId string The user group 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/usergroups/ug-114273/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 group permission for a given resource

Add resource permission to the user group.

POST /v1/usergroups/{userGroupId}/permissions

Path parameters

Name Type Description
userGroupId string The user group 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 group’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/usergroups/ug-114273/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 group permission for a given resource

Update resource permission of the user group.

POST /v1/usergroups/{userGroupId}/permissions/{resourceId}

Path parameters

Name Type Description
userGroupId string The user group 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 group’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/usergroups/ug-114273/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 group permission

Delete resource permission of a user group.

DELETE /v1/usergroups/{userGroupId}/permissions/{resourceId}

Path parameters

Name Type Description
userGroupId string The user group 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/usergroups/ug-114273/permisions/p-2343" -X DELETE -H "Authorization: Bearer syPHeMY5H--kdRtfpoXTgYFF7LHgVOhIjOQ5QkIvSD68VZvc2_uAew.P07tEVThD5SqNCV_tFwbAg"

Response

200 OK