Skip to content
shuffl
Get started

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

Reference

Linked accounts API

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

OpenAPI documentErrors and rate limitsSDK and CLI recipes

On this page

identities.list

List the Slack and web accounts linked to a person

POST/api/v1/manage/identities/list

const result = await shuffl.identities.list({
  "personId": "<personId>"
});
Request fields (1)
  • personId string required
Response object
  • rows object[] required
    • accountLabel string required
    • id string required
    • issuer string required
    • personId string required
    • provider string required
    • revision number required
    • revokedAt null | string (date-time) required
    • subject string required
    • teamId string required
    • verification string required
    • verifiedAt string (date-time) required
    • verifiedBy string required
  • slackConnected boolean required

identities.slackAccounts

List Slack accounts that can be linked to people

POST/api/v1/manage/identities/slackAccounts

const result = await shuffl.identities.slackAccounts({});
Request fields (1)
  • cursor string optional
Response object
  • accounts object[] required
    • id string required
    • name string required
    • personId null | string required
  • nextCursor string optional
  • revision number required
  • slackTeamId string required

identities.webAccounts

List web accounts that can be linked to people

POST/api/v1/manage/identities/webAccounts

const result = await shuffl.identities.webAccounts({});
Request fields (2)
  • awaitingAccess false | true optional
  • search string optional
Response object[]
  • email string required
  • emailVerified boolean required
  • id string required
  • name string required
  • personId null | string required
  • personName null | string required

identities.linkSlack

Link a verified Slack account

POST/api/v1/manage/identities/linkSlack

const result = await shuffl.identities.linkSlack({
  "personId": "<personId>",
  "revision": 0,
  "slackTeamId": "<slackTeamId>",
  "subject": "<subject>",
  "confirm": "identities.linkSlack",
  "requestKey": "a-new-unique-key"
});
Request fields (6)
  • personId string required
  • revision number required
  • slackTeamId string required
  • subject string required
  • confirm "identities.linkSlack" 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
    • id string required
    • issuer string required
    • personId string required
    • provider string required
    • revision number required
    • revokedAt null | string (date-time) required
    • subject string required
    • teamId string required
    • verification string required
    • verifiedAt string (date-time) required
    • verifiedBy string required

identities.linkWeb

Link a verified web account

POST/api/v1/manage/identities/linkWeb

  • Write
  • Permission identities.linkWeb
  • Needs a requestKey
  • Needs confirm set to identities.linkWeb
const result = await shuffl.identities.linkWeb({
  "personId": "<personId>",
  "userId": "<userId>",
  "confirm": "identities.linkWeb",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • personId string required
  • userId string required
  • confirm "identities.linkWeb" 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
    • id string required
    • issuer string required
    • personId string required
    • provider string required
    • revision number required
    • revokedAt null | string (date-time) required
    • subject string required
    • teamId string required
    • verification string required
    • verifiedAt string (date-time) required
    • verifiedBy string required

identities.unlink

Revoke an employee identity link

POST/api/v1/manage/identities/unlink

  • Write
  • Permission identities.unlink
  • Needs a requestKey
  • Needs confirm set to identities.unlink
const result = await shuffl.identities.unlink({
  "identityId": "<identityId>",
  "personId": "<personId>",
  "confirm": "identities.unlink",
  "requestKey": "a-new-unique-key"
});
Request fields (4)
  • identityId string required
  • personId string required
  • confirm "identities.unlink" 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
    • revoked boolean required