Skip to main content
POST
CreateOffboardingTask

Authorizations

Authorization
string
header
required

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

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

Create an offboarding task.

description
string | null

The description of the offboarding request.

expandMask
Task Expand Mask · object | null

The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.

subjectUserId
string | null

The ID of the user to offboard.

Response

200 - application/json

The TaskServiceCreateOffboardingResponse returns the created offboarding task with optional expanded related objects.

The TaskServiceCreateOffboardingResponse returns the created offboarding task with optional expanded related objects.

expanded
object[] | null
read-only

List of serialized related objects.

taskView
Task View · object | null

Contains a task and JSONPATH expressions that describe where in the expanded array related objects are located. This view can be used to display a fully-detailed dashboard of task information.