Returns all Application resources.

GET 
/Applications

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

Request

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

200

Returns all SCIM Application resources.

application/json

Schema

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[]

Array [

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.

]

Example (from schema)

{
  "totalResults": "18,",
  "startIndex": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "c0b4568a4fe7458c434ee77d1fbt156b",
      "name": "Active Directory",
      "descriptions": [
        {
          "locale": "en_US",
          "value": "The main Active_Directory domain data for the corporate network."
        }
      ],
      "type": "Active Directory - Direct",
      "features": [
        [
          "DIRECT_PERMISSIONS",
          "NO_RANDOM_ACCESS",
          "DISCOVER_SCHEMA"
        ]
      ],
      "owner": {
        "displayName": "Joe Smith",
        "value": "c0b4568a4fe7458c434ee77d1fbt156b",
        "$ref": "http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"
      },
      "applicationSchemas": {
        "value": "urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active Directory:account",
        "type": "account",
        "$ref": "http://localhost:8080/identityiq/scim/v2/Schemas/urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active%20Directory:account"
      },
      "meta": {
        "created": "2022-02-11T01:34:04.074-05:00",
        "location": "http://localhost:8080/identityiq/scim/v2/Applications/c0b4568a4fe7458c434ee77d1fbt156b",
        "lastModified": "2022-02-11T01:08:45.866-05:00",
        "version": "W\"1644561244074\"",
        "resourceType": "Application",
        "schemas": [
          "urn:ietf:params:scim:schemas:sailpoint:1.0:Application"
        ]
      }
    }
  ]
}

application/scim+json

Schema

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[]

The SCIM resources returned for this endpoint.

Array [

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.

]

Example (from schema)

{
  "totalResults": "1500,",
  "startIndex": 1,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "c0b4568a4fe7458c434ee77d1fbt156b",
      "name": "Active Directory",
      "descriptions": [
        {
          "locale": "en_US",
          "value": "The main Active_Directory domain data for the corporate network."
        }
      ],
      "type": "Active Directory - Direct",
      "features": [
        [
          "DIRECT_PERMISSIONS",
          "NO_RANDOM_ACCESS",
          "DISCOVER_SCHEMA"
        ]
      ],
      "owner": {
        "displayName": "Joe Smith",
        "value": "c0b4568a4fe7458c434ee77d1fbt156b",
        "$ref": "http://localhost:8080/identityiq/scim/v2/Users/c0b4568a4fe7458c434ee77d1fbt156b"
      },
      "applicationSchemas": {
        "value": "urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active Directory:account",
        "type": "account",
        "$ref": "http://localhost:8080/identityiq/scim/v2/Schemas/urn:ietf:params:scim:schemas:sailpoint:1.0:Application:Schema:Active%20Directory:account"
      },
      "meta": {
        "created": "2022-02-11T01:34:04.074-05:00",
        "location": "http://localhost:8080/identityiq/scim/v2/Applications/c0b4568a4fe7458c434ee77d1fbt156b",
        "lastModified": "2022-02-11T01:08:45.866-05:00",
        "version": "W\"1644561244074\"",
        "resourceType": "Application",
        "schemas": [
          "urn:ietf:params:scim:schemas:sailpoint:1.0:Application"
        ]
      }
    }
  ]
}

Loading...