Retrieve discovered applications for tenant

GET 
/discovered-applications

Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors.

Request

Query Parameters

limit int32
Possible values: <= 250
Default value: 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
Example: 250
offset int32
Default value: 0
Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Example: 0
detail string
Possible values: [SLIM, FULL]
Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior.
Example: FULL
filter string
Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
name: eq, sw, co
description: eq, sw, co
createdAtStart: eq, le, ge
createdAtEnd: eq, le, ge
discoveredAtStart: eq, le, ge
discoveredAtEnd: eq, le, ge
discoverySource: eq, in
Example: name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")
sorters comma-separated
Sort results using the standard syntax described in V3 API Standard Collection Parameters
Sorting is supported for the following fields: name, description, discoveredAt, discoverySource
Example: name

Responses

200

List of discovered applications. By default, the API returns a list of SLIM discovered applications.

application/json

Schema

Schema

• Array [

oneOf

Slim Discovered Application

Discovered applications

id uuid

Unique identifier for the discovered application.

name string

Name of the discovered application.

discoverySource string

Source from which the application was discovered.

discoveredVendor string

The vendor associated with the discovered application.

description string

A brief description of the discovered application.

recommendedConnectors string[]

List of recommended connectors for the application.

discoveredAt date-time

The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format.

createdAt date-time

The timestamp when the application was first discovered, in ISO 8601 format.

status string

The status of an application within the discovery source.

By default this field is set to "ACTIVE" when the application is discovered.

If an application has been deleted from within the discovery source, the status will be set to "INACTIVE".

Discovered Application

Discovered applications with their respective associated sources

id uuid

Unique identifier for the discovered application.

name string

Name of the discovered application.

discoverySource string

Source from which the application was discovered.

discoveredVendor string

The vendor associated with the discovered application.

description string

A brief description of the discovered application.

recommendedConnectors string[]

List of recommended connectors for the application.

discoveredAt date-time

The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format.

createdAt date-time

The timestamp when the application was first discovered, in ISO 8601 format.

status string

The status of an application within the discovery source.

By default this field is set to "ACTIVE" when the application is discovered.

If an application has been deleted from within the discovery source, the status will be set to "INACTIVE".

associatedSources uuid[]

List of associated sources related to this discovered application.

• ]

Example (from schema)

[
  {},
  {}
]

Slim Discovered Application

[
  {
    "id": "app-123",
    "name": "Example App",
    "discoverySource": "csv",
    "discoveredVendor": "Example Vendor",
    "description": "An application for managing examples.",
    "recommendedConnectors": [
      "ConnectorA",
      "ConnectorB"
    ],
    "discoveredAt": "2023-07-01T12:00:00Z",
    "createdAt": "2024-06-01T12:00:00Z",
    "status": "ACTIVE"
  },
  {
    "id": "app-456",
    "name": "Sample Tracker",
    "discoverySource": "Okta SaaS",
    "discoveredVendor": "Sample Vendor",
    "description": "A tool for monitoring and managing samples.",
    "recommendedConnectors": [
      "ConnectorC",
      "ConnectorD"
    ],
    "discoveredAt": "2023-08-15T08:00:00Z",
    "createdAt": "2024-05-20T08:00:00Z",
    "status": "ACTIVE"
  },
  {
    "id": "app-789",
    "name": "Demo Manager",
    "discoverySource": "Okta SaaS",
    "discoveredVendor": "Demo Provider",
    "description": "Software to demonstrate basic functionalities.",
    "recommendedConnectors": [
      "ConnectorE",
      "ConnectorF"
    ],
    "discoveredAt": "2023-09-10T15:00:00Z",
    "createdAt": "2024-07-03T15:00:00Z",
    "status": "ACTIVE"
  }
]

Discovered Application

[
  {
    "id": "app-123",
    "name": "Example App",
    "discoverySource": "csv",
    "discoveredVendor": "Example Vendor",
    "description": "An application for managing examples.",
    "recommendedConnectors": [
      "ConnectorA",
      "ConnectorB"
    ],
    "discoveredAt": "2023-07-01T12:00:00Z",
    "createdAt": "2024-06-01T12:00:00Z",
    "status": "ACTIVE",
    "associatedSources": [
      "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923"
    ]
  },
  {
    "id": "app-456",
    "name": "Sample Tracker",
    "discoverySource": "Okta SaaS",
    "discoveredVendor": "Sample Vendor",
    "description": "A tool for monitoring and managing samples.",
    "recommendedConnectors": [
      "ConnectorC",
      "ConnectorD"
    ],
    "discoveredAt": "2023-08-15T08:00:00Z",
    "createdAt": "2024-05-20T08:00:00Z",
    "status": "ACTIVE",
    "associatedSources": [
      "a3b159f2-5f09-43c9-b40e-a6f317aa5b8f",
      "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923"
    ]
  },
  {
    "id": "app-789",
    "name": "Demo Manager",
    "discoverySource": "Okta SaaS",
    "discoveredVendor": "Demo Provider",
    "description": "Software to demonstrate basic functionalities.",
    "recommendedConnectors": [
      "ConnectorE",
      "ConnectorF"
    ],
    "discoveredAt": "2023-09-10T15:00:00Z",
    "createdAt": "2024-07-03T15:00:00Z",
    "status": "ACTIVE",
    "associatedSources": [
      "4e2d7605-833f-4c34-8d03-5b2c7d2f4f66",
      "f9b7e2ce-aced-4117-a95f-4ffad8b33989",
      "a3b159f2-5f09-43c9-b40e-a6f317aa5b8f"
    ]
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...