Get Broker Identity Providers

This endpoint is responsible for fetching a summarized list of identity providers.

Request

URI

GET

https://{api_host}//federation/t/{tenant}/broker/identity-providers

COPY

Path Parameters

string

tenant

Required

The VMware Identity Services tenant ID

tenant example

my-tenant

Authentication

This operation uses the following authentication methods.

admin

Responses

200

Identity providers list returned successfully.

Returns BrokerIdentityProviderList of type(s) application/vnd.vmware.vidm.federation.broker.identityprovider.list+json

{
    "items": [
        {
            "_links": {
                "self": {
                    "href": "https://example.com/path-to-self"
                }
            },
            "id": "string",
            "idp_name": "example_idp_name",
            "idp_type": "OIDC",
            "directory_ids": [
                "string"
            ]
        }
    ],
    "_links": {
        "self": {
            "href": "https://example.com/path-to-self"
        }
    }
}

array of BrokerShortIdentityProviderMedia

items

Optional

items

object

_links

Optional

The resource HATEOAS links. Usually includes a "self" link for this resource

401

Unauthorized to list Identity Providers.

Operation doesn't return any data structure

403