Vcenter Identity Providers list

Retrieve all identity providers.

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

Operation execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

Request

URI

GET

https://{api_host}/api/vcenter/identity/providers

COPY

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

200

Commonly used information about the identity providers.

[
    {
        "provider": "string",
        "name": "string",
        "config_tag": "string",
        "oauth2": {
            "auth_endpoint": "string",
            "token_endpoint": "string",
            "client_id": "string",
            "authentication_header": "string",
            "auth_query_params": {
                "auth_query_params": [
                    "string"
                ]
            }
        },
        "oidc": {
            "discovery_endpoint": "string",
            "logout_endpoint": "string",
            "auth_endpoint": "string",
            "token_endpoint": "string",
            "client_id": "string",
            "authentication_header": "string",
            "auth_query_params": {
                "auth_query_params": [
                    "string"
                ]
            }
        },
        "is_default": false,
        "domain_names": [
            "string"
        ],
        "auth_query_params": {
            "auth_query_params": [
                "string"
            ]
        },
        "federation_type": "string"
    }
]

array of Vcenter Identity Providers Summary

Optional

403

if authorization is not given to caller.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/identity/providers

On This Page

Description

Request

Authentication

Response

200 Response Body

Errors

Vcenter Operations

GET

Vcenter Identity Providers list

POST

Vcenter Identity Providers create

GET

Vcenter Identity Providers get

DELETE

Vcenter Identity Providers delete

PATCH

Vcenter Identity Providers update