Querying Application Provider Details

Function

This API is used to query application provider details. 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/{application_provider_id}

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
application_provider_id	Yes	String	Application provider ID.

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_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 4** 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.

Status code: 400

**Table 5** 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 6** 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.

Status code: 404

**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.

Example Request

Querying application provider details

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

Example Response

Status code: 200

Successful.

{
  "application_provider_id" : "app-xxxxxxx",
  "application_provider_urn" : "IdentityCenter::x-xxxxx",
  "display_data" : {
    "description" : "description",
    "display_name" : "custom-saml"
  },
  "federation_protocol" : "SAML"
}