Skip to content
This repository was archived by the owner on Sep 3, 2021. It is now read-only.

CustomRolesApi.md

Latest commit

 

History

History
161 lines (98 loc) · 3.99 KB

CustomRolesApi.md

File metadata and controls

161 lines (98 loc) · 3.99 KB

CustomRolesApi

All URIs are relative to /api/v2

Method HTTP request Description
deleteCustomRole DELETE /roles/{customRoleKey} Delete a custom role by key.
getCustomRole GET /roles/{customRoleKey} Get one custom role by key.
getCustomRoles GET /roles Return a complete list of custom roles.
patchCustomRole PATCH /roles/{customRoleKey} Modify a custom role by key.
postCustomRole POST /roles Create a new custom role.

deleteCustomRole

Delete a custom role by key.

Example

 deleteCustomRole customRoleKey=value

Parameters

Name Type Description Notes
customRoleKey string The custom role key.

Return type

(empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCustomRole

Get one custom role by key.

Example

 getCustomRole customRoleKey=value

Parameters

Name Type Description Notes
customRoleKey string The custom role key.

Return type

CustomRole

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCustomRoles

Return a complete list of custom roles.

Example

 getCustomRoles

Parameters

This endpoint does not need any parameter.

Return type

CustomRoles

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchCustomRole

Modify a custom role by key.

Example

 patchCustomRole customRoleKey=value

Parameters

Name Type Description Notes
customRoleKey string The custom role key.
patchDelta array[PatchOperation] Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'

Return type

CustomRole

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postCustomRole

Create a new custom role.

Example

 postCustomRole

Parameters

Name Type Description Notes
customRoleBody CustomRoleBody New role or roles to create.

Return type

CustomRole

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]