Skip to content
shuffl
Get started

Searches the public product guides only. Nothing from a workspace is read, and questions are not saved.

Reference

Access requests API

8 operations. Generated from the OpenAPI document, so this page always matches the API.

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

accessRequests.get

Read one access request you asked for, approve or own

POST/api/v1/manage/accessRequests/get

const result = await shuffl.accessRequests.get({
  "requestId": "<requestId>"
});
Request fields (1)
  • requestId string required
Response object
  • app object required
    • id string required
    • logoUrl null | string required
    • name string required
  • approvers object[] required
    • id string required
    • name string required
  • canDecide boolean required
  • canGrant boolean required
  • canRevoke boolean required
  • createdAt string required
  • decidedAt null | string required
  • decidedBy null | object required
    • id string required
    • name string required
  • decisionNote null | string required
  • errorCode null | string required
  • expiresAt string required
  • grant null | object required
    • Option 1 object optional
      • kind "manual" required
    • Option 2 object optional
      • connectionId string required
      • groups object[] required
        • confirmed boolean required
        • externalId string required
        • name string required
      • kind "group" required
      • provider string required
  • grantedAt null | string required
  • grantsAutomatically boolean required
  • id string required
  • level null | object required
    • id string required
    • name string required
  • note string required
  • person object required
    • id string required
    • name string required
  • revision number required
  • revokedAt null | string required
  • status "approved" | "declined" | "expired" | "failed" | "granted" | "granting" | "pending_approval" | "requested" | "revoked" required
  • statusLabel string required

accessRequests.inbox

List the access requests waiting on you to decide or set up

POST/api/v1/manage/accessRequests/inbox

const result = await shuffl.accessRequests.inbox();
Request fields (none)

This operation takes no input.

Response object
  • owner boolean required
  • toDecide object[] required
    • app object required
      • id string required
      • logoUrl null | string required
      • name string required
    • approvers object[] required
      • id string required
      • name string required
    • canDecide boolean required
    • canGrant boolean required
    • canRevoke boolean required
    • createdAt string required
    • decidedAt null | string required
    • decidedBy null | object required
      • id string required
      • name string required
    • decisionNote null | string required
    • errorCode null | string required
    • expiresAt string required
    • grant null | object required
      • Option 1 object optional
        • kind "manual" required
      • Option 2 object optional
        • connectionId string required
        • groups object[] required
        • kind "group" required
        • provider string required
    • grantedAt null | string required
    • grantsAutomatically boolean required
    • id string required
    • level null | object required
      • id string required
      • name string required
    • note string required
    • person object required
      • id string required
      • name string required
    • revision number required
    • revokedAt null | string required
    • status "approved" | "declined" | "expired" | "failed" | "granted" | "granting" | "pending_approval" | "requested" | "revoked" required
    • statusLabel string required
  • toGrant object[] required
    • app object required
      • id string required
      • logoUrl null | string required
      • name string required
    • approvers object[] required
      • id string required
      • name string required
    • canDecide boolean required
    • canGrant boolean required
    • canRevoke boolean required
    • createdAt string required
    • decidedAt null | string required
    • decidedBy null | object required
      • id string required
      • name string required
    • decisionNote null | string required
    • errorCode null | string required
    • expiresAt string required
    • grant null | object required
      • Option 1 object optional
        • kind "manual" required
      • Option 2 object optional
        • connectionId string required
        • groups object[] required
        • kind "group" required
        • provider string required
    • grantedAt null | string required
    • grantsAutomatically boolean required
    • id string required
    • level null | object required
      • id string required
      • name string required
    • note string required
    • person object required
      • id string required
      • name string required
    • revision number required
    • revokedAt null | string required
    • status "approved" | "declined" | "expired" | "failed" | "granted" | "granting" | "pending_approval" | "requested" | "revoked" required
    • statusLabel string required

accessRequests.list

List access requests across the workspace, by app or status

POST/api/v1/manage/accessRequests/list

const result = await shuffl.accessRequests.list({});
Request fields (3)
  • appId string optional
  • limit number optional
  • status "approved" | "declined" | "expired" | "failed" | "granted" | "granting" | "pending_approval" | "requested" | "revoked" optional
Response object[]
  • app object required
    • id string required
    • logoUrl null | string required
    • name string required
  • approvers object[] required
    • id string required
    • name string required
  • canDecide boolean required
  • canGrant boolean required
  • canRevoke boolean required
  • createdAt string required
  • decidedAt null | string required
  • decidedBy null | object required
    • id string required
    • name string required
  • decisionNote null | string required
  • errorCode null | string required
  • expiresAt string required
  • grant null | object required
    • Option 1 object optional
      • kind "manual" required
    • Option 2 object optional
      • connectionId string required
      • groups object[] required
        • confirmed boolean required
        • externalId string required
        • name string required
      • kind "group" required
      • provider string required
  • grantedAt null | string required
  • grantsAutomatically boolean required
  • id string required
  • level null | object required
    • id string required
    • name string required
  • note string required
  • person object required
    • id string required
    • name string required
  • revision number required
  • revokedAt null | string required
  • status "approved" | "declined" | "expired" | "failed" | "granted" | "granting" | "pending_approval" | "requested" | "revoked" required
  • statusLabel string required

accessRequests.mine

List your own access requests and where each stands

POST/api/v1/manage/accessRequests/mine

const result = await shuffl.accessRequests.mine();
Request fields (none)

This operation takes no input.

Response object[]
  • app object required
    • id string required
    • logoUrl null | string required
    • name string required
  • approvers object[] required
    • id string required
    • name string required
  • canDecide boolean required
  • canGrant boolean required
  • canRevoke boolean required
  • createdAt string required
  • decidedAt null | string required
  • decidedBy null | object required
    • id string required
    • name string required
  • decisionNote null | string required
  • errorCode null | string required
  • expiresAt string required
  • grant null | object required
    • Option 1 object optional
      • kind "manual" required
    • Option 2 object optional
      • connectionId string required
      • groups object[] required
        • confirmed boolean required
        • externalId string required
        • name string required
      • kind "group" required
      • provider string required
  • grantedAt null | string required
  • grantsAutomatically boolean required
  • id string required
  • level null | object required
    • id string required
    • name string required
  • note string required
  • person object required
    • id string required
    • name string required
  • revision number required
  • revokedAt null | string required
  • status "approved" | "declined" | "expired" | "failed" | "granted" | "granting" | "pending_approval" | "requested" | "revoked" required
  • statusLabel string required

accessRequests.decide

Approve or decline an access request you were asked to decide

POST/api/v1/manage/accessRequests/decide

const result = await shuffl.accessRequests.decide({
  "decision": "approve",
  "requestId": "<requestId>",
  "confirm": "accessRequests.decide",
  "requestKey": "a-new-unique-key"
});
Request fields (6)
  • decision "approve" | "decline" required
  • expectedRevision number optional
  • note string optional
  • requestId string required
  • confirm "accessRequests.decide" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • app object required
      • id string required
      • logoUrl null | string required
      • name string required
    • approvers object[] required
      • id string required
      • name string required
    • canDecide boolean required
    • canGrant boolean required
    • canRevoke boolean required
    • createdAt string required
    • decidedAt null | string required
    • decidedBy null | object required
      • id string required
      • name string required
    • decisionNote null | string required
    • errorCode null | string required
    • expiresAt string required
    • grant null | object required
      • Option 1 object optional
        • kind "manual" required
      • Option 2 object optional
        • connectionId string required
        • groups object[] required
        • kind "group" required
        • provider string required
    • grantedAt null | string required
    • grantsAutomatically boolean required
    • id string required
    • level null | object required
      • id string required
      • name string required
    • note string required
    • person object required
      • id string required
      • name string required
    • revision number required
    • revokedAt null | string required
    • status "approved" | "declined" | "expired" | "failed" | "granted" | "granting" | "pending_approval" | "requested" | "revoked" required
    • statusLabel string required

accessRequests.markGranted

Mark an approved request as set up, so the person is told

POST/api/v1/manage/accessRequests/markGranted

const result = await shuffl.accessRequests.markGranted({
  "requestId": "<requestId>",
  "confirm": "accessRequests.markGranted",
  "requestKey": "a-new-unique-key"
});
Request fields (3)
  • requestId string required
  • confirm "accessRequests.markGranted" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • app object required
      • id string required
      • logoUrl null | string required
      • name string required
    • approvers object[] required
      • id string required
      • name string required
    • canDecide boolean required
    • canGrant boolean required
    • canRevoke boolean required
    • createdAt string required
    • decidedAt null | string required
    • decidedBy null | object required
      • id string required
      • name string required
    • decisionNote null | string required
    • errorCode null | string required
    • expiresAt string required
    • grant null | object required
      • Option 1 object optional
        • kind "manual" required
      • Option 2 object optional
        • connectionId string required
        • groups object[] required
        • kind "group" required
        • provider string required
    • grantedAt null | string required
    • grantsAutomatically boolean required
    • id string required
    • level null | object required
      • id string required
      • name string required
    • note string required
    • person object required
      • id string required
      • name string required
    • revision number required
    • revokedAt null | string required
    • status "approved" | "declined" | "expired" | "failed" | "granted" | "granting" | "pending_approval" | "requested" | "revoked" required
    • statusLabel string required

accessRequests.request

Ask for access to an app

POST/api/v1/manage/accessRequests/request

const result = await shuffl.accessRequests.request({
  "appId": "<appId>",
  "requestKey": "a-new-unique-key",
  "confirm": "accessRequests.request"
});
Request fields (6)
  • appId string required
  • forPersonId string optional
  • levelId string optional
  • note string optional
  • requestKey string required1 to 128 characters
  • confirm "accessRequests.request" required
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • app object required
      • id string required
      • logoUrl null | string required
      • name string required
    • approvers object[] required
      • id string required
      • name string required
    • canDecide boolean required
    • canGrant boolean required
    • canRevoke boolean required
    • createdAt string required
    • decidedAt null | string required
    • decidedBy null | object required
      • id string required
      • name string required
    • decisionNote null | string required
    • duplicate boolean required
    • errorCode null | string required
    • expiresAt string required
    • grant null | object required
      • Option 1 object optional
        • kind "manual" required
      • Option 2 object optional
        • connectionId string required
        • groups object[] required
        • kind "group" required
        • provider string required
    • grantedAt null | string required
    • grantsAutomatically boolean required
    • id string required
    • level null | object required
      • id string required
      • name string required
    • note string required
    • person object required
      • id string required
      • name string required
    • revision number required
    • revokedAt null | string required
    • status "approved" | "declined" | "expired" | "failed" | "granted" | "granting" | "pending_approval" | "requested" | "revoked" required
    • statusLabel string required

accessRequests.revoke

Remove access that was granted through a request

POST/api/v1/manage/accessRequests/revoke

const result = await shuffl.accessRequests.revoke({
  "requestId": "<requestId>",
  "confirm": "accessRequests.revoke",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • note string optional
  • requestId string required
  • confirm "accessRequests.revoke" required
  • requestKey string required1 to 128 characters
Response object
  • receipt object required
    • completedAt string (date-time) | null required
    • createdAt string (date-time) required
    • id string (uuid) required
    • operation string required
    • requestKey string required
    • status "running" | "succeeded" | "failed" | "unknown" required
  • result object | null required
    • app object required
      • id string required
      • logoUrl null | string required
      • name string required
    • approvers object[] required
      • id string required
      • name string required
    • canDecide boolean required
    • canGrant boolean required
    • canRevoke boolean required
    • createdAt string required
    • decidedAt null | string required
    • decidedBy null | object required
      • id string required
      • name string required
    • decisionNote null | string required
    • errorCode null | string required
    • expiresAt string required
    • grant null | object required
      • Option 1 object optional
        • kind "manual" required
      • Option 2 object optional
        • connectionId string required
        • groups object[] required
        • kind "group" required
        • provider string required
    • grantedAt null | string required
    • grantsAutomatically boolean required
    • id string required
    • level null | object required
      • id string required
      • name string required
    • note string required
    • person object required
      • id string required
      • name string required
    • revision number required
    • revokedAt null | string required
    • status "approved" | "declined" | "expired" | "failed" | "granted" | "granting" | "pending_approval" | "requested" | "revoked" required
    • statusLabel string required