GET rbac/access requests/:access request id/reviewers

From Social ID Developers
Jump to: navigation, search

Contents

Description

Searches for Reviewers in an Access Request.

Resource URL

  GET https://api.socialidnow.com/v1/rbac/access_requests/:access_request_id/reviewers

Parameters

URL Parameters

access_request_id required access request identifier.
login_user_id optional user identifier.
page optional page number (each page contains page_size results). Default: 1.
page_size optional maximum amount of results to be returned. Default: 8.

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

A successful search returns the following fields:

total total amount of access request reviewers found.
offset amount of discarded access request reviewers (page start).
count amount of access request reviewers returned in this page.
results array with access request reviewers details:
login_user_id user identifier.
login_user user details. See response from GET login/users/:user_id
source_type source of the access request reviewer assignment. Possible values: "group" or "custom".
source_id source identifier.
created_at date of access request reviewer assignment creation.

Examples

Without search parameters

Request

curl -iX GET 'https://api.socialidnow.com/v1/rbac/access_requests/10/reviewers' \
  --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf

Response

Response Headers
HTTP/1.1 200 Ok
Status: 200
Response Body
{
  "total": 3,
  "offset": 0,
  "count": 3,
  "results": [
    {
      "login_user_id": 1,
      "login_user": {
        "id": 1,
        "signed_in_at": "2021-08-10T21:27:00Z",
        "signed_up_at": "2021-07-10T21:27:00Z",
        "token": "12345678901234567890123456789012",
        "username": "anna_archer",
        "email_address": "anna_archer@domain.com",
        "active": true,
        "confirmed": true,
        "locked": false
      },
      "source_type": "group",
      "source_id": "100",
      "created_at": "2023-08-10T21:27:00Z"
    },
    {
      "login_user_id": 2,
      "login_user": {
        "id": 2,
        "signed_in_at": "2022-08-10T21:28:00Z",
        "signed_up_at": "2022-07-10T21:28:00Z",
        "token": "12345678901234567890123456789012",
        "username": "benjamin_branch",
        "email_address": "benjamin_branch@domain.com",
        "active": true,
        "confirmed": true,
        "locked": false
      },
      "source_type": "group",
      "source_id": "200",
      "created_at": "2023-08-10T21:28:00Z"
    },
    {
      "login_user_id": 3,
      "login_user": {
        "id": 3,
        "signed_in_at": "2023-08-10T21:29:00Z",
        "signed_up_at": "2023-07-10T21:29:00Z",
        "token": "12345678901234567890123456789012",
        "username": "christina_chambers",
        "email_address": "christina_chambers@domain.com",
        "active": true,
        "confirmed": true,
        "locked": false
      },
      "source_type": "custom",
      "source_id": "admin",
      "created_at": "2023-08-10T21:29:00Z"
    }
  ]
}

With search parameters

Request

curl -iX GET 'https://api.socialidnow.com/v1/rbac/access_requests/10/reviewers?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": [
    {
      "login_user_id": 2,
      "login_user": {
        "id": 2,
        "signed_in_at": "2022-08-10T21:28:00Z",
        "signed_up_at": "2022-07-10T21:28:00Z",
        "token": "12345678901234567890123456789012",
        "username": "benjamin_branch",
        "email_address": "benjamin_branch@domain.com",
        "active": true,
        "confirmed": true,
        "locked": false
      },
      "source_type": "group",
      "source_id": "200",
      "created_at": "2023-08-10T21:28:00Z"
    }
  ]
}
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox