> ## Documentation Index > Fetch the complete documentation index at: https://mintlify.hoop.dev/docs/llms.txt > Use this file to discover all available pages before exploring further. # Claim Sidecar Approval Request > Answer a sidecar waiting on one approval request it filed. An approved request is consumed once and releases the statement, or is reserved (PROCESSING) when the body asks to reserve it; a request past its deadline is expired and never releases it; any other status is returned as it stands. It never files an approval request. ## OpenAPI ````yaml https://use.hoop.dev/api/openapiv3.json post /sidecars/reviews/{id}/claim openapi: 3.0.3 info: contact: email: help@hoop.dev name: Help url: https://help.hoop.dev description: >- Hoop.dev is an access gateway for databases and servers with an API for packet manipulation license: name: MIT url: https://opensource.org/license/mit termsOfService: https://hoop.dev/docs/legal/tos title: Hoop Api version: 1.244.0 servers: - url: https://use.hoop.dev/api security: [] tags: - description: > Hoop implements Oauth2 and OIDC protocol to authenticate users in the system. To obtain a valid access token users need to authenticate in their own identity provider which is generated as a JSON response to the endpoint `http(s)://use.hoop.dev/api/login`. The identity provider them redirects the user to the callback endpoint containing the access token. The recommended approach of obtaining an access token is by visiting the Webapp main's page or using the **Hoop command line**. Example: ```sh hoop config create --api-url https://use.hoop.dev # save the token after authenticating at $HOME/.hoop/config.toml hoop login # show token information hoop config view --raw ``` With an access token you could use any HTTP client to interact with the documented endpoints. The token must be sent through the `Authorization` header. Example: ```sh # obtain the current configuration of the server curl https://use.hoop.dev/api/serverinfo -H "Authorization: Bearer $ACCESS_TOKEN" ``` name: Authentication - description: > Users are active and assigned to the default organization when they signup. A user could be set to an inactive state preventing it from accessing the platform, however it’s recommended to manage the state of users in the identity provider. - The `sub` claim is used as the main identifier of the user in the platform. - The profile of the user is derived from the id_token claims `email` and `name`. When a user authenticates for the first time, it performs an automatic signup that persist the profile claims along with it’s unique identifier. ​ ### Groups Groups allows defining who may access or interact with certain resources. - For connection resources it’s possible to define which groups has access to a specific connection, this is enforced when the Access Control feature is enabled. - For review resources, it’s possible to define which groups are allowed to approve an execution, this is enforced when the Review feature is enabled. > This resource could be managed manually via Webapp or propagated by the identity provider via ID Token. In this mode, groups are sync when a user performs a login. ### Roles - The `admin` group is a special role that grants full access to all resources This role should be granted to users that are responsible for managing the Gateway. All other users are regular, meaning that they can access their own resources and interact with connections. name: User Management - name: Machine Identities - description: Routes used to manage and obtain information about the runtime server. name: Server Management - description: Features available in the gateway. See also **Plugin** resources. name: Features - description: >- Proxy manager endpoints controls how clients connect via gRPC in the gateway. These endpoints are meant to be used when a client is initialized via `hoop proxy-manager`. name: Proxy Manager - name: Connections - name: Agents - name: Sidecars - name: Runbooks - name: Guard Rails - name: Approvals - name: Sessions - name: Organization Management - name: Reports - description: > Security audit log API. Only users in the **admin** group can access these endpoints. Audit log entries record security-relevant events (who performed an action, when, on which resource, and whether it succeeded). Use the list endpoint with filters to query by actor, resource type, action, outcome, or date range. Results are paginated and ordered by `created_at` descending. name: Audit Logs paths: /sidecars/reviews/{id}/claim: post: tags: - Sidecars summary: Claim Sidecar Approval Request description: >- Answer a sidecar waiting on one approval request it filed. An approved request is consumed once and releases the statement, or is reserved (PROCESSING) when the body asks to reserve it; a request past its deadline is expired and never releases it; any other status is returned as it stands. It never files an approval request. parameters: - description: >- The token returned when the sidecar was created. Omit it when sending hoop-sidecar-identity. in: header name: hoop-sidecar-token schema: type: string - description: >- A Kubernetes or Google service account JWT, raw, that a sidecar service account mapping allows. Omit it when sending hoop-sidecar-token. in: header name: hoop-sidecar-identity schema: type: string - description: The approval request id in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/openapi.SidecarReviewClaimRequest' description: Optional; an empty body spends an approved request x-originalParamName: request responses: '200': content: application/json: schema: $ref: '#/components/schemas/openapi.SidecarReviewResponse' description: OK '400': content: application/json: schema: $ref: '#/components/schemas/openapi.HTTPError' description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/openapi.HTTPError' description: Unauthorized '404': content: application/json: schema: $ref: '#/components/schemas/openapi.HTTPError' description: Not Found '500': content: application/json: schema: $ref: '#/components/schemas/openapi.HTTPError' description: Internal Server Error components: schemas: openapi.SidecarReviewClaimRequest: properties: reserve: description: >- Reserve an approved request instead of spending it, as on SidecarReviewRequest example: false type: boolean type: object openapi.SidecarReviewResponse: properties: forward: description: >- Whether the sidecar may release the statement it held True only on the request that consumed or reserved an approved request, and only once per claim. False while the approval request waits or a reservation is in flight, and false forever once it is rejected, revoked or expired. example: false type: boolean review: allOf: - $ref: '#/components/schemas/openapi.Review' description: >- The approval request the statement is waiting on, or the one that released it type: object openapi.HTTPError: properties: message: example: the error description type: string type: object openapi.Review: properties: access_duration: default: 1800000000000 description: >- The amount of time (nanoseconds) to allow access to the connection. It's valid only for `jit` type approval requests example: 0 readOnly: true type: integer access_request_rule_name: description: >- The name of the access request rule that triggered this approval request, if null means it was triggered by the review plugin example: default-access-request-rule readOnly: true type: string approval_ttl_sec: description: >- The time a sidecar approval lasts, in seconds, copied from the rule at filing. Absent with no limit or on an approval request from a connection example: 600 readOnly: true type: integer connection: allOf: - $ref: '#/components/schemas/openapi.ReviewConnection' description: >- The connection the approval request was filed against. On a sidecar approval request, the resource that mirrors the listener; absent while the organization has no mirror for it readOnly: true created_at: description: The time the resource was created example: '2024-07-25T15:56:35.317601Z' readOnly: true type: string expires_at: description: >- The deadline of a sidecar approval request: to decide while PENDING, to use the approval once APPROVED. Absent with no limit or on an approval request from a connection example: '2024-07-25T16:11:35.000Z' readOnly: true type: string force_approval_groups: description: Groups that can force approve sessions for this approval request example: - sre-team items: type: string readOnly: true type: array id: description: Resource identifier example: 9F9745B4-C77B-4D52-84D3-E24F67E3623C format: uuid readOnly: true type: string listener_name: description: >- The sidecar listener this approval request is bound to. Absent on an approval request that came from a connection example: appdb readOnly: true type: string min_approvals: description: The minimum number of approvals required for this approval request example: 2 readOnly: true type: integer rejection_reason: description: >- The reason provided by the approver when rejecting this approval request example: This command is not allowed in production. readOnly: true type: string review_groups_data: description: Contains the groups that must approve this request items: $ref: '#/components/schemas/openapi.ReviewGroup' readOnly: true type: array revoke_at: description: The time when this approval request was revoked example: '' readOnly: true type: string session: description: The id of session example: 35DB0A2F-E5CE-4AD8-A308-55C3108956E5 format: uuid readOnly: true type: string sidecar_id: description: >- The sidecar that filed this approval request. Absent on an approval request that came from a connection example: 5F5E5C6E-6C3A-4E9A-9E8B-2D6A7F1B0C4D format: uuid readOnly: true type: string status: allOf: - $ref: '#/components/schemas/openapi.ReviewStatusType' description: >- The status of the approval request * PENDING - The resource is waiting for approval * APPROVED - The resource is fully approved * REJECTED - The resource is fully rejected * REVOKED - The resource was revoked after being approved * PROCESSING - The approval request is being executed * EXECUTED - The approval request was executed * UNKNOWN - Unable to know the status of the approval request * EXPIRED - A sidecar approval request passed its deadline; it never releases the statement time_window: allOf: - $ref: '#/components/schemas/openapi.ReviewSessionTimeWindow' description: The time window configuration that can execute the session readOnly: true type: allOf: - $ref: '#/components/schemas/openapi.ReviewType' description: |- The type of the approval request * onetime - Represents a one time execution * jit - Represents a time based approval enum: - onetime - jit readOnly: true type: object openapi.ReviewConnection: properties: id: description: The resource identifier example: 20A5AABE-C35D-4F04-A5A7-C856EE6C7703 readOnly: true type: string name: description: The name of the connection example: pgdemo readOnly: true type: string type: object openapi.ReviewGroup: properties: forced_review: description: Indicates if this group forced the approval example: false readOnly: true type: boolean group: description: The group to approve this request example: sre readOnly: true type: string id: description: The resource identifier example: 20A5AABE-C35D-4F04-A5A7-C856EE6C7703 format: uuid readOnly: true type: string review_date: description: The date of this decision example: '2024-07-25T19:36:41Z' readOnly: true type: string reviewed_by: allOf: - $ref: '#/components/schemas/openapi.ReviewOwner' description: The approver readOnly: true status: allOf: - $ref: '#/components/schemas/openapi.ReviewRequestStatusType' description: |- The approval status * APPROVED - Approve the approval request * REJECTED - Reject the approval request * REVOKED - Revoke an approved request example: APPROVED type: object openapi.ReviewStatusType: enum: - PENDING - APPROVED - REJECTED - REVOKED - PROCESSING - EXECUTED - UNKNOWN - EXPIRED type: string x-enum-varnames: - ReviewStatusPending - ReviewStatusApproved - ReviewStatusRejected - ReviewStatusRevoked - ReviewStatusProcessing - ReviewStatusExecuted - ReviewStatusUnknown - ReviewStatusExpired openapi.ReviewSessionTimeWindow: properties: configuration: additionalProperties: type: string example: end_time: '18:00' start_time: '09:00' type: object type: allOf: - $ref: '#/components/schemas/openapi.ReviewTimeWindowType' enum: - time_range required: - configuration - type type: object openapi.ReviewType: enum: - jit - onetime type: string x-enum-varnames: - ReviewTypeJit - ReviewTypeOneTime openapi.ReviewOwner: properties: email: description: The email of the owner example: john.wick@bad.org readOnly: true type: string id: description: The resource identifier example: D5BFA2DD-7A09-40AE-AFEB-C95787BA9E90 format: uuid readOnly: true type: string name: description: The display name of the owner example: John Wick readOnly: true type: string slack_id: description: The Slack ID of the owner example: U053ELZHB53 readOnly: true type: string type: object openapi.ReviewRequestStatusType: enum: - APPROVED - REJECTED - REVOKED type: string x-enum-varnames: - ReviewStatusRequestApprovedType - ReviewStatusRequestRejectedType - ReviewStatusRequestRevokedType openapi.ReviewTimeWindowType: enum: - time_range type: string x-enum-varnames: - ReviewTimeWindowTypeTimeRange ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.