GET rbac/access certification campaigns/reviews
From Social ID Developers
(Difference between revisions)
(Created page with "== Description == Searches for Access Certification Campaign Reviews. == Resource URL == GET https://api.socialidnow.com/v1/rbac/access_certification_campaigns/reviews ...") |
(→URL Parameters) |
||
Line 12: | Line 12: | ||
{| | {| | ||
− | ! align="left" width=" | + | ! align="left" width="250px" | ids |
| width="200px" | optional | | width="200px" | optional | ||
| comma separated list of access certification campaign review ids. Example: ids=1,2,3. | | comma separated list of access certification campaign review ids. Example: ids=1,2,3. | ||
|- | |- | ||
− | ! align="left" width=" | + | ! align="left" width="250px" | page |
| width="200px" | optional | | width="200px" | optional | ||
| page number (each page contains page_size results). Default: 1. | | page number (each page contains page_size results). Default: 1. | ||
|- | |- | ||
− | ! align="left" width=" | + | ! align="left" width="250px" | page_size |
| width="200px" | optional | | width="200px" | optional | ||
| maximum amount of results to be returned. Default: 8. | | maximum amount of results to be returned. Default: 8. | ||
|- | |- | ||
− | ! align="left" width=" | + | ! align="left" width="250px" | access_certification_campaign_id |
| width="200px" | optional | | width="200px" | optional | ||
| access certification campaign identifier. | | access certification campaign identifier. | ||
|- | |- | ||
− | ! align="left" width=" | + | ! align="left" width="250px" | login_user_id |
| width="200px" | optional | | width="200px" | optional | ||
| user identifier. | | user identifier. | ||
|- | |- | ||
− | ! align="left" width=" | + | ! align="left" width="250px" | role_id |
| width="200px" | optional | | width="200px" | optional | ||
| role identifier. | | role identifier. | ||
|- | |- | ||
− | ! align="left" width=" | + | ! align="left" width="250px" | reviewer_id |
| width="200px" | optional | | width="200px" | optional | ||
| reviewer identifier. | | reviewer identifier. | ||
|- | |- | ||
− | ! align="left" width=" | + | ! align="left" width="250px" | status |
| width="200px" | optional | | width="200px" | optional | ||
| access certification campaign review status. Allowed values: pending, approved, revoked. | | access certification campaign review status. Allowed values: pending, approved, revoked. |
Latest revision as of 16:53, 20 February 2024
Contents |
Description
Searches for Access Certification Campaign Reviews.
Resource URL
GET https://api.socialidnow.com/v1/rbac/access_certification_campaigns/reviews
Parameters
URL Parameters
ids | optional | comma separated list of access certification campaign review 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. |
access_certification_campaign_id | optional | access certification campaign identifier. |
login_user_id | optional | user identifier. |
role_id | optional | role identifier. |
reviewer_id | optional | reviewer identifier. |
status | optional | access certification campaign review status. Allowed values: pending, approved, revoked. |
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 certification campaign reviews found. |
---|---|
offset | amount of discarded access certification campaign reviews (page start). |
count | amount of access certification campaign reviews returned in this page. |
results | array with access certification campaign review details: See response from GET rbac/access_certification_campaigns/reviews/:access_certification_campaign_review_id |
Examples
Without search parameters
Request
curl -iX GET 'https://api.socialidnow.com/v1/rbac/access_certification_campaigns/reviews' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{ "total": 3, "offset": 0, "count": 3, "results": [ { "id": 1, "status": "pending", "comment": "First Access Certification Campaign Review comment", "access_certification_campaign_id": 123, "login_user_id": 234, "role_id": 345, "reviewer_id": 456, "source_type": "group", "source_id": "567", "created_at": "2024-02-20T13:30:00Z", "updated_at": "2024-02-20T13:30:00Z" }, { "id": 2, "status": "approved", "comment": "Second Access Certification Campaign Review comment", "access_certification_campaign_id": 231, "login_user_id": 342, "role_id": 453, "reviewer_id": 564, "source_type": "access_request", "source_id": "675", "created_at": "2024-02-20T13:35:00Z", "updated_at": "2024-02-20T13:35:00Z" }, { "id": 3, "status": "revoked", "comment": "Third Access Certification Campaign Review comment", "access_certification_campaign_id": 312, "login_user_id": 423, "role_id": 534, "reviewer_id": 645, "source_type": "custom", "source_id": "admin", "created_at": "2024-02-20T13:40:00Z", "updated_at": "2024-02-20T13:40:00Z" } ] }
With search parameters
Request
curl -iX GET 'https://api.socialidnow.com/v1/rbac/access_certification_campaigns/reviews?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, "status": "approved", "comment": "Second Access Certification Campaign Review comment", "access_certification_campaign_id": 231, "login_user_id": 342, "role_id": 453, "reviewer_id": 564, "source_type": "access_request", "source_id": "675", "created_at": "2024-02-20T13:35:00Z", "updated_at": "2024-02-20T13:35:00Z" } ] }