Skip to main content
POST
CreateGrantTask

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 a grant task.

appEntitlementId
string | null
required

The ID of the app entitlement to grant access to.

appId
string | null
required

The ID of the app that is associated with the entitlement.

appUserId
string | null

The ID of the app user to grant access for. This field and identityUserId cannot both be set for a given request.

description
string | null

The description of the request.

emergencyAccess
boolean | null

Boolean stating whether or not the task is marked as emergency access.

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.

grantDuration
string<duration> | null
identityUserId
string | null

The ID of the user associated with the app user we are granting access for. This field cannot be set if appUserID is also set.

requestData
object | null
source
Task Grant Source · object | null

The TaskGrantSource message tracks which external URL was the source of the specificed grant ticket.

Response

200 - application/json

The TaskServiceCreateGrantResponse returns a task view which has a task including JSONPATHs to the expanded items in the expanded array.

The TaskServiceCreateGrantResponse returns a task view which has a task including JSONPATHs to the expanded items in the expanded array.

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.