GET rbac/access requests/:access request id
From Social ID Developers
(Difference between revisions)
(Created page with "== Description == Returns an Access Request. == Resource URL == GET https://api.socialidnow.com/v1/rbac/access_requests/:access_request_id == Parameters == === URL Par...") |
(→Response Body) |
||
Line 53: | Line 53: | ||
|- | |- | ||
! align="left" width="200px" | requester_type | ! align="left" width="200px" | requester_type | ||
− | | requester type. | + | | requester type. Possible values: "login_user" or "custom". |
|- | |- | ||
! align="left" width="200px" | requester_id | ! align="left" width="200px" | requester_id | ||
Line 59: | Line 59: | ||
|- | |- | ||
! align="left" width="200px" | status | ! align="left" width="200px" | status | ||
− | | access request status. | + | | access request status. Possible values: "pending", "accepted" or "rejected". |
|- | |- | ||
! align="left" width="200px" | description | ! align="left" width="200px" | description |
Latest revision as of 23:30, 10 August 2023
Contents |
Description
Returns an Access Request.
Resource URL
GET https://api.socialidnow.com/v1/rbac/access_requests/:access_request_id
Parameters
URL Parameters
access_request_id | required | access request identifier. |
---|
Authentication
This API requires Account authentication. See Authentication.
Response
Response Status
ok (200) | The request was successful. |
---|---|
unauthorized (401) | The authentication is wrong. See Authentication. |
forbidden (403) | The account does not have access to this access request. |
internal_server_error (500) | An unknown error happened. |
Response Body
The following fields are returned:
id | access request identifier. |
---|---|
role_id | role identifier. |
target_id | target user identifier. |
requester_type | requester type. Possible values: "login_user" or "custom". |
requester_id | requester identifier. |
status | access request status. Possible values: "pending", "accepted" or "rejected". |
description | access request description. |
created_at | date of access request creation. |
updated_at | date of access request latest update. |
Examples
Request
curl -X GET 'https://api.socialidnow.com/v1/rbac/access_requests/1' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{ "id": 1, "role_id": 100, "target_id": 30, "requester_type": "login_user", "requester_id": "30", "description": "Second Access Request", "status": "accepted", "created_at": "2023-08-10T19:34:00Z", "updated_at": "2023-08-10T19:34:00Z" }