Skip to main content

Returns all Application resources.​

This endpoint returns all Application 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 Applications is:

  • urn:ietf:params:scim:schemas:core:1.0:Application
Query Parameters
  • filter string

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

  • lookupByName boolean
  • 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: 1

    Specifies the number of results per page.

  • attributes string

    The Application attributes to include in the response. The query parameter value is a comma-separated list of fields to be returned in the response for each Application. The attributes listed will be the only ones returned in the response, with the exception of id, schemas, and meta, which are always returned for an Application.

  • excludedAttributes string

    The Application attributes to exclude frome the response. The query parameter value is a comma-separated list of fields to be excluded from the response for each Application. The attributes listed will be the only ones excluded frome the response, with the exception of id, schemas, and meta, which are always returned for an Application.

Responses

Returns all SCIM Application resources.

Schema
  • totalResults integer

    Number of Application resources returned.

  • 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

    IdentityIQ id of the Application.

  • name string

    Unique name for the Application. This name MUST be unique across the entire set of Applications.

  • descriptions array

    A list of localized descriptions of the Application.

  • type string

    The type of the Application.

  • features array

    A list of features of the Application.

  • owner object

    The owner of the Application.

  • displayName string

    Display name of the application owner.

  • value string

    id of the application owner.

  • $ref string

    URI reference of the application owner resource.

  • applicationSchemas object

    List of the Application Schemas.

  • value string

    The urn of the Application Schema.

  • type string

    The type of Application Schema (account, group, etc.).

  • $ref string

    The URI of the SCIM resource representing the Entitlement.

  • meta

    Metadata of the SCIM resource.

  • created date-time

    Datetime this Application was created.

  • location string

    The location of the SCIM resource.

  • lastModified date-time

    Datetime the Application was last modified.

  • version string

    The version of the SCIM resource.

  • resourceType string

    The SCIM resource type.

  • schemas string[]

    The schemas involved in the SCIM resource.

Loading...