Skip to content
shuffl
Get started

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

Reference

Employee access API

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

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

access.get

Read one person's workspace role and app access

POST/api/v1/manage/access/get

const result = await shuffl.access.get({
  "personId": "<personId>"
});
Request fields (1)
  • personId string required
Response object
  • access object required
    • employment "employed" | "ended" | "on_leave" | "unknown" required
    • personId string required
    • provisioningActive null | false | true required
    • revision number required
    • status "enabled" | "pending" | "suspended" required
    • teamId string required
    • updatedAt string (date-time) required
  • actorRole "admin" | "member" | "owner" required
  • history object[] required
    • action string required
    • actorId null | string required
    • createdAt string (date-time) required
    • details object required
    • entityId null | string required
    • id string required
    • teamId string required
  • membership null | object required
    • companyRole "admin" | "member" | "owner" required
    • isSelf boolean required
    • role "admin" | "member" | "owner" required

access.slackWaiting

List Slack members waiting for access to Shuffl

POST/api/v1/manage/access/slackWaiting

const result = await shuffl.access.slackWaiting();
Request fields (none)

This operation takes no input.

Response object
  • people object[] required
    • blocked null | "bot" | "employment_ended" | "not_found" | "not_pending" | "provisioning_denied" | "slack_inactive" | "slack_unavailable" required
    • email null | string required
    • employment "employed" | "ended" | "on_leave" | "unknown" required
    • id string required
    • name string required
  • truncated boolean required

access.enableSlack

Give these Slack people employee access

POST/api/v1/manage/access/enableSlack

  • Write
  • Permission access.enableSlack
  • Needs a requestKey
  • Needs confirm set to access.enableSlack
const result = await shuffl.access.enableSlack({
  "personIds": [
    "<personIds>"
  ],
  "reason": "<reason>",
  "confirm": "access.enableSlack",
  "requestKey": "a-new-unique-key"
});
Request fields (5)
  • markEmployed false | true optional
  • personIds string[] required
  • reason string required
  • confirm "access.enableSlack" 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
    • enabled string[] required
    • skipped object[] required
      • personId string required
      • reason "bot" | "employment_ended" | "not_found" | "not_pending" | "provisioning_denied" | "slack_inactive" | "slack_unavailable" required

access.save

Change employee product access

POST/api/v1/manage/access/save

  • Write
  • Permission access.save
  • Needs a requestKey
  • Needs confirm set to access.save
const result = await shuffl.access.save({
  "employment": "employed",
  "expectedRevision": 0,
  "personId": "<personId>",
  "reason": "<reason>",
  "status": "enabled",
  "confirm": "access.save",
  "requestKey": "a-new-unique-key"
});
Request fields (7)
  • employment "employed" | "ended" | "on_leave" | "unknown" required
  • expectedRevision number required
  • personId string required
  • reason string required
  • status "enabled" | "pending" | "suspended" required
  • confirm "access.save" 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
    • revision number required
    • saved boolean required

access.saveRole

Change a member’s team role

POST/api/v1/manage/access/saveRole

  • Write
  • Permission access.saveRole
  • Needs a requestKey
  • Needs confirm set to access.saveRole
const result = await shuffl.access.saveRole({
  "expectedRole": "admin",
  "personId": "<personId>",
  "role": "admin",
  "confirm": "access.saveRole",
  "requestKey": "a-new-unique-key"
});
Request fields (5)
  • expectedRole "admin" | "member" | "owner" required
  • personId string required
  • role "admin" | "member" | "owner" required
  • confirm "access.saveRole" 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
    • role "admin" | "member" | "owner" required