User
GET Users#
Get all user.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/organizations/{organizationId}/users |
| Headers | Authorization |
| Parameters | projectId, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {organizationId} | Yes | string($uuid) | v1 | The identifier of organization |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| organizationId | Yes | string($uuid) | v1 | The identifier of organization |
| PageIndex | No | integer($int32) | 0 | |
| PageSize | No | integer($int32) | 10 | |
| Search | No | string | "string" |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "email": "string", "name": "string", "lastname": "string", "role": "string" } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns an object of project's user | |
| id | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of user project |
| string | "string" | Returns the email of user that created project | |
| name | string | "string" | Returns the name of user that created project |
| lastname | string | "string" | Returns the lastname of user that created project |
| defaultOrganizationId | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the default identifier of organization |
| defaultProjectId | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the default identifier of project |
| role | string | "string" | Returns the role of user project |
| resultInfo | array [object] | Returns an object of project's user | |
| totalCount | integer($int32) | 0 | How many records of project's user entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
POST User#
Add or invite a user to the organization.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/organizations/{organizationId}/users |
| Headers | Authorization |
| Parameters | organizationId, version |
| Body | { email, roleId } |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| organizations | Yes | string($uuid) | v1 | Directs to the organizations |
| {organizationId} | Yes | string | v1 | The identifier for the organization |
| users | Yes | string | v1 | Directs to the users |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| organizationId | Yes | string($uuid) | v1 | The identifier for the organization |
Request body#
{ "email": "string", "roleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Yes | string | "string" | Sends the email of user | |
| roleId | Yes | string | "string" | Sends the role identifier of the user for the following project |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "email": "string", "name": "string", "lastname": "string", "defaultOrganizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "defaultProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "role": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "description": "string", "isDefault": true, "permissionCount": 0 } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns an object of project's user | |
| id | string | "string" | Returns the identifier of role |
| string | "string" | Returns the email of the user | |
| name | string | "string" | Returns the name of user |
| lastname | string | "string" | Returns lastname of user |
| defaultOrganizationId | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the organization |
| defaultProjectId | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of project |
| roles | array [object] | Returns an object of project's user role | |
| id | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of role |
| name | string | "string" | Returns the name of user role |
| description | string | "string" | Returns the description of user |
| isDefault | bool | true | |
| permissionCount | integer($int32) | 0 | |
| type | string | "string" | Returns the type of role |
| title | string | "string" | Returns the title of role |
| resultInfo | array [object] | Returns an object of project's user | |
| totalCount | integer($int32) | 0 | How many records of project's user entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET User#
Get user by id
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/organizations/{organizationId}/users/{userId} |
| Headers | Authorization |
| Parameters | organizationId , version, userId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {organizationId} | Yes | string($uuid) | v1 | The identifier for the organization |
| {userId} | Yes | string($uuid) | v1 | The identifier for the user |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| userId | Yes | string($uuid) | v1 | The identifier for the user |
| organizationId | Yes | string($uuid) | v1 | The identifier for the organization |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "email": "string", "name": "string", "lastname": "string", "defaultOrganizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "defaultProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "role": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "description": "string", "isDefault": true, "permissionCount": 0 } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns an object of project's user | |
| id | string | "string" | Returns the identifier of role |
| string | "string" | Returns the email of the user | |
| name | string | "string" | Returns the name of user |
| lastname | string | "string" | Returns lastname of user |
| defaultOrganizationId | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the organization |
| defaultProjectId | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of project |
| roles | array [object] | Returns an object of project's user role | |
| id | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of role |
| name | string | "string" | Returns the name of user role |
| description | string | "string" | Returns the description of user |
| isDefault | bool | true | |
| permissionCount | integer($int32) | 0 | |
| type | string | "string" | Returns the type of role |
| title | string | "string" | Returns the title of role |
| resultInfo | array [object] | Returns an object of project's user | |
| totalCount | integer($int32) | 0 | How many records of project's user entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
PUT User#
Update user role in the organization
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/organizations/{organizationId}/users/{userId} |
| Headers | Authorization |
| Parameters | organizationId, version, userId |
| Body | { roleId } |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| organizations | Yes | string($uuid) | v1 | Directs to the organizations |
| {organizationId} | Yes | string | v1 | The identifier for the organization |
| users | Yes | string | v1 | Directs to the users |
| {userId} | Yes | string | v1 | The identifier for the user |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| organizationId | Yes | string($uuid) | v1 | The identifier for the organization |
| userId | Yes | string | v1 | The identifier for the user |
Request body#
{ "roleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| roleId | Yes | string | "string" | Sends the role identifier of the user for the following project |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "email": "string", "name": "string", "lastname": "string", "defaultOrganizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "defaultProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "role": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "description": "string", "isDefault": true, "permissionCount": 0 } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns an object of project's user | |
| id | string | "string" | Returns the identifier of role |
| string | "string" | Returns the email of the user | |
| name | string | "string" | Returns the name of user |
| lastname | string | "string" | Returns lastname of user |
| defaultOrganizationId | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the organization |
| defaultProjectId | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of project |
| roles | array [object] | Returns an object of project's user role | |
| id | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of role |
| name | string | "string" | Returns the name of user role |
| description | string | "string" | Returns the description of user |
| isDefault | bool | true | |
| permissionCount | integer($int32) | 0 | |
| type | string | "string" | Returns the type of role |
| title | string | "string" | Returns the title of role |
| resultInfo | array [object] | Returns an object of project's user | |
| totalCount | integer($int32) | 0 | How many records of project's user entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
DELETE User#
Remove user from the organization
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/organizations/{organizationId}/users/{userId} |
| Headers | Authorization |
| Parameters | organizationId, version, userId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| organizations | Yes | string($uuid) | v1 | Directs to the organizations |
| {organizationId} | Yes | string | v1 | The identifier for the organization |
| users | Yes | string | v1 | Directs to the users |
| {userId} | Yes | string | v1 | The identifier for the user |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| organizationId | Yes | string($uuid) | v1 | The identifier for the organization |
| userId | Yes | string | v1 | The identifier for the user |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "email": "string", "name": "string", "lastname": "string", "defaultOrganizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "defaultProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "role": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "description": "string", "isDefault": true, "permissionCount": 0 } }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns an object of project's user | |
| id | string | "string" | Returns the identifier of role |
| string | "string" | Returns the email of the user | |
| name | string | "string" | Returns the name of user |
| lastname | string | "string" | Returns lastname of user |
| defaultOrganizationId | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of the organization |
| defaultProjectId | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of project |
| roles | array [object] | Returns an object of project's user role | |
| id | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of role |
| name | string | "string" | Returns the name of user role |
| description | string | "string" | Returns the description of user |
| isDefault | bool | true | |
| permissionCount | integer($int32) | 0 | |
| type | string | "string" | Returns the type of role |
| title | string | "string" | Returns the title of role |
| resultInfo | array [object] | Returns an object of project's user | |
| totalCount | integer($int32) | 0 | How many records of project's user entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
Get User Permission#
Checks if user has specific permission
| GET | |
|---|---|
| Method | GET |
| URL or EndPoint | /api/v{version}/projects/{projectId}/users/{globalId}/permissions/{permission} |
| Headers | Authorization |
| Parameters | projectId, globalId, permission, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | v1 | The identifier for the project |
| {globalId} | Yes | string($uuid) | v1 | The identifier for the user |
| {permission} | Yes | string($uuid) | v1 | The permission for the user |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| projectId | Yes | string($uuid) | v1 | The identifier for the project |
| globalId | Yes | string | v1 | The identifier for the user |
| permission | Yes | string | v1 | The permission for the user |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "permission": true, "organizationIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ]}| Field Name | Type | Example | Description |
|---|---|---|---|
| userId | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of user |
| permission | bool | true | Returns true if user has permission |
| organizationIds | string | "3fa85f64-5717-4562-b3fc-2c963f66afa6" | Returns the identifier of organization |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found