Skip to main content
GET
/
reviews
/
{id}
Get Review
curl --request GET \
  --url https://use.hoop.dev/api/reviews/{id}
{
  "access_duration": 0,
  "access_request_rule_name": "default-access-request-rule",
  "created_at": "2024-07-25T15:56:35.317601Z",
  "force_approval_groups": [
    "sre-team"
  ],
  "id": "9F9745B4-C77B-4D52-84D3-E24F67E3623C",
  "min_approvals": 2,
  "rejection_reason": "This command is not allowed in production.",
  "review_groups_data": [
    {
      "forced_review": false,
      "group": "sre",
      "id": "20A5AABE-C35D-4F04-A5A7-C856EE6C7703",
      "review_date": "2024-07-25T19:36:41Z",
      "reviewed_by": {
        "email": "john.wick@bad.org",
        "id": "D5BFA2DD-7A09-40AE-AFEB-C95787BA9E90",
        "name": "John Wick",
        "slack_id": "U053ELZHB53"
      },
      "status": "APPROVED"
    }
  ],
  "revoke_at": "",
  "session": "35DB0A2F-E5CE-4AD8-A308-55C3108956E5",
  "time_window": {
    "configuration": {
      "end_time": "18:00",
      "start_time": "09:00"
    },
    "type": "time_range"
  }
}

Path Parameters

​
id
string
required

Resource identifier of the review

Response

OK

​
access_duration
integer
default:1800000000000
read-only

The amount of time (nanoseconds) to allow access to the connection. It's valid only for jit type reviews

Example:

0

​
access_request_rule_name
string
read-only

The name of the access request rule that triggered this review, if null means it was triggered by the review plugin

Example:

"default-access-request-rule"

​
created_at
string
read-only

The time the resource was created

Example:

"2024-07-25T15:56:35.317601Z"

​
force_approval_groups
string[]
read-only

Groups that can force approve sessions for this review

Example:
["sre-team"]
​
id
string<uuid>
read-only

Resource identifier

Example:

"9F9745B4-C77B-4D52-84D3-E24F67E3623C"

​
min_approvals
integer
read-only

The minimum number of approvals required for this review

Example:

2

​
rejection_reason
string
read-only

The reason provided by the reviewer when rejecting this review

Example:

"This command is not allowed in production."

​
review_groups_data
object[]
read-only

Contains the groups that requires to approve this review

​
revoke_at
string
read-only

The time when this review was revoked

Example:

""

​
session
string<uuid>
read-only

The id of session

Example:

"35DB0A2F-E5CE-4AD8-A308-55C3108956E5"

​
status
enum<string>

The status of the review

  • PENDING - The resource is waiting to be reviewed
  • APPROVED - The resource is fully approved
  • REJECTED - The resource is fully rejected
  • REVOKED - The resource was revoked after being approved
  • PROCESSING - The review is being executed
  • EXECUTED - The review was executed
  • UNKNOWN - Unable to know the status of the review
Available options:
PENDING,
APPROVED,
REJECTED,
REVOKED,
PROCESSING,
EXECUTED,
UNKNOWN
​
time_window
object

The time window configuration that can execute the session

​
type
enum<string>

The type of the review

  • onetime - Represents a one time execution
  • jit - Represents a time based review
Available options:
onetime,
jit