People

Internal Users

The organisation's internal-staff directory (internal-type users): directory, profile, lifecycle (status, delete), roles, 2FA, SSO id, key-contact, and email log.

Operations (17)

• GETList internal users
• POSTInvite an internal user
• GETGet an internal user
• PATCHUpdate an internal user
• DELETEDeactivate an internal user
• POSTActivate many internal users
• POSTSuspend many internal users
• GETList the roles an internal user holds
• POSTGive an internal user a role
• PUTReplace an internal user's roles
• DELETETake a role from an internal user
• POSTActivate an internal user
• POSTSuspend an internal user
• POSTSend an internal user their invitation
• POSTSet an internal user's single sign-on id
• GETList an internal user's emails
• GETGet an internal user's email

Deprecated (4)

These still work but have a replacement; see each operation for its sunset date.

• PATCHSet an internal user's statusDeprecated
• POST(Re)send internal user invitationDeprecated
• PATCHBulk set internal user statusDeprecated
• PUTSet an internal user's SSO idDeprecated