POST rbac/access requests
From Social ID Developers
(Difference between revisions)
(Created page with "== Description == Creates an Access Request. == Resource URL == POST https://api.socialidnow.com/v1/rbac/access_requests == Parameters == === JSON Parameters === {| !...") |
(→JSON Parameters) |
||
Line 26: | Line 26: | ||
! align="left" width="180px" style="padding-left: 20px" | requester_type | ! align="left" width="180px" style="padding-left: 20px" | requester_type | ||
| width="200px" | optional | | width="200px" | optional | ||
− | | requester type. Allowed values: login_user | + | | requester type. Allowed values: "login_user" or "custom". Default: "custom". |
|- | |- | ||
! align="left" width="180px" style="padding-left: 20px" | requester_id | ! align="left" width="180px" style="padding-left: 20px" | requester_id |
Latest revision as of 23:29, 10 August 2023
Contents |
Description
Creates an Access Request.
Resource URL
POST https://api.socialidnow.com/v1/rbac/access_requests
Parameters
JSON Parameters
access_request | required | a hash in the format field:value, with the necessary fields to create an access request: |
---|---|---|
role_id | required | role identifier. |
target_id | required | target user identifier. |
requester_type | optional | requester type. Allowed values: "login_user" or "custom". Default: "custom". |
requester_id | optional | requester identifier. Default: api. |
description | optional | access request description. |
Authentication
This API requires Account authentication. See Authentication.
Response
Response Status
created (201) | The access request 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 the role, target or requester. |
unprocessable_entity (422) | Validation error in the field "access_request". |
internal_server_error (500) | An unknown error happened. |
Examples
Request
curl -iX POST 'https://api.socialidnow.com/v1/rbac/access_requests' \ -d '{ "access_request": { "role_id":10, "target_id":100, "requester_type":"login_user", "requester_id":1000, "description":"My Access Request description" } }' \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 201 Created Location: 'https://api.socialidnow.com/v1/rbac/access_requests/1' Status: 201