GET rbac/access requests
From Social ID Developers
(Difference between revisions)
(Created page with "== Description == Searches for Access Requests. == Resource URL == GET https://api.socialidnow.com/v1/rbac/access_requests == Parameters == === URL Parameters === {| ...") |
|||
Line 30: | Line 30: | ||
! align="left" width="200px" | requester_type | ! align="left" width="200px" | requester_type | ||
| width="200px" | optional | | width="200px" | optional | ||
− | | requester type. | + | | requester type. Possible values: "login_user" or "custom". |
|- | |- | ||
! align="left" width="200px" | role_id | ! align="left" width="200px" | role_id |
Latest revision as of 23:28, 10 August 2023
Contents |
Description
Searches for Access Requests.
Resource URL
GET https://api.socialidnow.com/v1/rbac/access_requests
Parameters
URL Parameters
ids | optional | comma separated list of access request ids. Example: ids=1,2,3. |
---|---|---|
page | optional | page number (each page contains page_size results). Default: 1. |
page_size | optional | maximum amount of results to be returned. Default: 8. |
requester_id | optional | requester identifier. |
requester_type | optional | requester type. Possible values: "login_user" or "custom". |
role_id | optional | role identifier. |
status | optional | access request status. Allowed values: pending, accepted, rejected. |
target_id | optional | target user 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. |
internal_server_error (500) | An unknown error happened. |
Response Body
A successful search returns the following fields:
total | total amount of access requests found. |
---|---|
offset | amount of discarded access requests (page start). |
count | amount of access requests returned in this page. |
results | array with access requests details: See response from GET rbac/access_requests/:access_request_id |
Examples
Without search parameters
Request
curl -iX GET 'https://api.socialidnow.com/v1/rbac/access_requests' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{ "total": 3, "offset": 0, "count": 3, "results": [ { "id": 1, "role_id": 100, "target_id": 20, "requester_type": "custom", "requester_id": "admin", "description": "First Access Request", "status": "pending", "created_at": "2023-08-10T19:13:00Z", "updated_at": "2023-08-10T19:13:00Z" }, { "id": 2, "role_id": 100, "target_id": 30, "requester_type": "login_user", "requester_id": "30", "description": "Second Access Request", "status": "accepted", "created_at": "2023-08-10T19:14:00Z", "updated_at": "2023-08-10T19:14:00Z" }, { "id": 3, "role_id": 100, "target_id": 40, "requester_type": "login_user", "requester_id": "10", "description": "Third Access Request", "status": "rejected", "created_at": "2023-08-10T19:15:00Z", "updated_at": "2023-08-10T19:15:00Z" } ] }
With search parameters
Request
curl -iX GET 'https://api.socialidnow.com/v1/rbac/access_requests?page_size=1&page=2' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{ "total": 3, "offset": 1, "count": 1, "results": [ { "id": 2, "role_id": 100, "target_id": 30, "requester_type": "login_user", "requester_id": "30", "description": "Second Access Request", "status": "accepted", "created_at": "2023-08-10T19:14:00Z", "updated_at": "2023-08-10T19:14:00Z" } ] }