Skip to main content

Returns all Workflow resources.​

This endpoint returns all Workflow resources.

Attributes to include in the response can be specified with the 'attributes' query parameter.

Attributes to exclude from the response can be specified with the 'excludedAttributes' query parameter.

The schema related to Workflow is:

  • urn:ietf:params:scim:schemas:sailpoint:1.0:Workflow
Query Parameters
  • filter string

    Allows for query filters according to RFC-7644, Section 3.4.2.2 - not all operations are supported.

  • lookupByName boolean

    (OPTIONAL) Set to true if the Workflows name is passed instead of the Workflow id.

  • sortBy string

    Allows sorting the results by a resource's attributes.

  • sortOrder string

    Default value: ascending

    Determines what order to sort results in.

  • startIndex integer

    Default value: 1

    Determines the starting index of the result set.

  • count integer

    Default value: 1000

    Specifies the number of results per page.

  • attributes string

    A comma-separated list of attributes to return in the response. This query parameter supersedes excludedAttributes, so providing the same attribute(s) to both will result in the attribute(s) being returned.

  • excludedAttributes string

    A comma-separated list of attributes to exclude from the response. Some attributes cannot be excluded.

Responses

Returned all SCIM resources for this endpoint.

Schema
  • totalResults integer

    Number of resources returned for this endpoint.

  • startIndex integer

    The starting index of the resource set list. Can be specified with startIndex query parameter.

  • schemas string[]

    SCIM Schema used for response.

  • Resources undefined[]
  • id string

    Unique identifier of the Workflow.

  • name string

    Name of the Workflow.

  • description string

    Description of the Workflow.

  • type string

    Possible values: [Batch Provisioning, Scheduled Assignment, Scheduled Role Activation, Managed Attribute, Identity Correlation, Identity Event, Identity Lifecycle, Identity Update, Identity Refresh, LCM Identity, LCM Provisioning, LCM Registration, Policy Violation, Role Modeler, Subprocess, Password Intercept, Alert, Attribute Sync]

    Type of the Workflow.

  • handler string

    Handler of the Workflow.

  • meta object
  • created string

    DateTime when the Workflow was created.

  • location string

    URL to the Workflow.

  • lastModified string

    DateTime of Workflow last modification.

  • version string

    Workflow version.

  • resourceType string

    Resource type of the metadata subject.

Loading...