Help Center/ IAM Identity Center/ API Reference/ API/ Application Management/ Listing Application Providers
Updated on 2025-11-27 GMT+08:00
View PDF

Listing Application Providers

Function

This API is used to list application providers. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

GET /v1/application-providers

Table 1 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Maximum number of results returned for each request.

marker

No

String

Pagination marker.

Request Parameters

Table 2 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

Table 3 Parameters in the response body

Parameter

Type

Description

application_providers

Array of ApplicationProviderDto objects

List of application providers.

page_info

PageInfoDto object

Pagination information.
Table 4 ApplicationProviderDto

Parameter

Type

Description

application_provider_urn

String

Application provider URN.

display_data

DisplayDataDto object

Display information of an application provider.

federation_protocol

String

Supported protocols.

application_provider_id

String

Unique ID of an application provider.
Table 5 DisplayDataDto

Parameter

Type

Description

description

String

Description of an application provider.

display_name

String

Display name of an application provider.

icon_url

String

Icon of an application provider.
Table 6 PageInfoDto

Parameter

Type

Description

next_marker

String

If present, more output is available than that included in the current response. To get the next part of the output, use this value in the request parameter in a subsequent call to the same API. You should repeat calling until the next_marker parameter is null in a response.

current_count

Integer

Number of items returned on this page.

Status code: 400

Table 7 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Status code: 403

Table 8 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

encoded_authorization_message

String

Encrypted error message.

Example Request

Listing application providers

GET https://{hostname}/v1/application-providers

Example Response

Status code: 200

Successful

{
  "application_providers" : [ {
    "application_provider_id" : "app-xxxxxx",
    "application_provider_urn" : "IdentityCenter::x-xxxxx",
    "display_data" : {
      "description" : "description",
      "display_name" : "custom-saml"
    },
    "federation_protocol" : "SAML"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

Error Codes

For details, see Error Codes.

Parent topic: Application Management