GET Permissions of User
Overview
The following table contains important information about the GET
method in regards to receiving the permissions the user.
GET Permissions of User | |
---|---|
Method | GET |
URL or Endpoint | /api/accounts/users/organizationId /permissions |
Headers | Authorization |
Parameters | organizationId, projectId |
Body | Not applicable. |
The description of the URL parameter is as follows:
organizationId URL parameter | |
---|---|
Field Name | orgnizationId |
Mandatory | Yes |
Type | string |
Description | The ID of the organization. |
The description of the parameter is as follows:
projectId parameter | |
---|---|
Field Name | projectId |
Mandatory | Yes |
Type | string |
Description | The ID of the project. |
Request Body
The request does not contain a request body
Response
{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": 38,
"name": "Ads",
"key": "ads.write",
"title": "Write"
}
],
"resultInfo": null,
"statusCode": 200
}
Field Name | Type | Description |
---|---|---|
success | bool | If the response is successful it will return true. Otherwise will return false. |
errors | array[] | Indicates if there was an error. |
messages | array[] | Returns the response message from back-end. |
result | array[Object] | Returns the response object. |
id | integer($int32) | The ID of the permission. |
name | string | The name of the permission. |
key | string | The key of the permsission. |
title | string | The title of the permission. |
resultInfo | string | Returns extra information about the result. |
statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed