Skip to main content
GET
/
apps
/
jumpcloud
/
bulk
/
userstates
List Scheduled Userstate Change Jobs
curl --request GET \
  --url https://api.provident.ae/v2/apps/jumpcloud/bulk/userstates \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "userId": "<string>",
    "state": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "activationEmailOverride": "<string>",
    "sendActivationEmails": true
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
number

The number of records to return at once. Default is 10, max is 100.

​
skip
number

The offset into the records to return. Default is 0.

​
filter
string

A filter to apply to the query.

​
userid
string

The systemuser id to filter by.

Response

OK

​
id
string
required

The ID of the scheduled state change request.

​
userId
string
required

The ID of the System User this entry is specific to.

​
state
string
required

The state to set for the user.

​
startDate
string<date-time>
required

The timestamp for when the state change will occur.

​
activationEmailOverride
string

An email address that overrides the system user's primary email address for activation email delivery.

​
sendActivationEmails
boolean

Determines if activation emails are sent.