POST rbac/roles
From Social ID Developers
(Difference between revisions)
(Created page with "== Description == Creates a Role. == Resource URL == POST https://api.socialidnow.com/v1/rbac/roles == Parameters == === JSON Parameters === {| ! align="left" width="...") |
(→JSON Parameters) |
||
| Line 18: | Line 18: | ||
! align="left" width="180px" style="padding-left: 20px" | name | ! align="left" width="180px" style="padding-left: 20px" | name | ||
| width="200px" | required | | width="200px" | required | ||
| − | | | + | | role name. |
|- | |- | ||
! align="left" width="180px" style="padding-left: 20px" | login_app_id | ! align="left" width="180px" style="padding-left: 20px" | login_app_id | ||
Latest revision as of 00:25, 18 November 2022
Contents |
Description
Creates a Role.
Resource URL
POST https://api.socialidnow.com/v1/rbac/roles
Parameters
JSON Parameters
| role | required | a hash in the format field:value, with the necessary fields to create a role: |
|---|---|---|
| name | required | role name. |
| login_app_id | required | application identifier. |
| description | optional | role description. |
Authentication
This API requires Account authentication. See Authentication.
Response
Response Status
| created (201) | The role was created successfully. |
|---|---|
| bad_request (400) | Some required parameter was not informed. |
| unauthorized (401) | The authentication is wrong. See Authentication. |
| forbidden (403) | The account does not have access to this application. |
| unprocessable_entity (422) | Validation error in the field "role". |
| internal_server_error (500) | An unknown error happened. |
Examples
Request
curl -iX POST 'https://api.socialidnow.com/v1/rbac/roles' \ -d '{ "role": { "name":"Role A", "login_app_id":100, "description":"My Role A description" } }' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 201 Created Location: 'https://api.socialidnow.com/v1/rbac/roles/1' Status: 201
