Skip to main content
POST
Create a user snapshot

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Snapshot display name shown in the snapshot picker.

Required string length: 1 - 120
sourceOrgId
string
required

Organization containing the user being snapshotted.

sourceUserId
string
required

User whose state is being captured.

description
string

Free-form notes describing what this snapshot captures.

Maximum string length: 500

Response

Snapshot created

snapshot
object
required
Example:
message
string