Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Access Requests (EAP)

Get Access Request

get/v2/facts/{proj_id}/{env_id}/access_requests/{elements_config_id}/user/{user_id}/tenant/{tenant_id}/{access_request_id}

Path parameters

access_request_idstring required

Either the unique id of the access_request, or the URL-friendly key of the access_request (i.e: the "slug").

Either the unique id of the access_request, or the URL-friendly key of the access_request (i.e: the "slug").

tenant_idstring required

Either the unique id of the tenant, or the URL-friendly key of the tenant (i.e: the "slug").

Either the unique id of the tenant, or the URL-friendly key of the tenant (i.e: the "slug").

user_idstring required

Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").

Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

elements_config_idstring required

Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").

Either the unique id of the elements_config, or the URL-friendly key of the elements_config (i.e: the "slug").

Response

Successful Response

reasonstring

Optional business justification provided by the user requesting access

idstring uuid required

Unique id of the access request

organization_idstring uuid required

Unique id of the organization that the access request belongs to.

project_idstring uuid required

Unique id of the project that the access request belongs to.

environment_idstring uuid required

Unique id of the environment that the access request belongs to.

created_atstring date-time required

Date and time when the access request was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the access request was last updated/modified (ISO_8601 format).

requesting_user_idstring uuid

optional id of the user that is requesting the access

reviewed_atstring date-time

when the access request was reviewed

type'access_request' | 'operation_approval'

An enumeration.

reviewer_commentstring

comment provided by the reviewer_user_id

status'pending' | 'approved' | 'denied' | 'canceled' required

An enumeration.

reviewer_user_idstring uuid

Optional id of the user who review the access request

Example response

{
  "requesting_user_id": "1c1e4ada-f282-40e6-b3b7-20b3a51c93b5",
  "access_request_details": {
    "tenant": "34f5c98e-f430-457b-a812-92637d0c6fd0",
    "resource": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
    "resource_instance": "2d98d9f8-e1b7-4f1d-baad-2edbf6fa6c66",
    "role": "ac4e70c8-d5be-48af-93eb-760f58fc91a9"
  },
  "reason": "string",
  "org_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "env_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "status": "approved",
  "reviewer_user_id": "1b287364-14ff-4b72-8953-b40399093a6f",
  "reviewed_at": "2019-08-24T14:15:22Z",
  "reviewer_comment": "new employee",
  "type": "access_request"
}