Skip to main content

List OIDC Providers

Request

Allows a user to page through all of the OIDC providers which are defined for a root project. The project is identified by the project id or ern provided. Access control is fine-grained, based on the project whose OIDC providers are being listed.

The auth token's access policy must allow action:use/pageOidcProviders.

Security
bearerAuth
Path
projectIdstring(ProjectId)^project:[0-9a-zA-Z](?![^:]*-$)(?![^:]*--)[0-...required

Globally unique identifier of a project. Callers may URL encode this value.

Example:project:abc-123
Query
includeSuspendedboolean

When true, include suspended OIDC providers in the results.

Example:includeSuspended=false
pageTokenstring, [ 1 .. 4096 ] characters(PageToken)

Opaque token identifying the page of results to retrieve.

Example:pageToken=eyJwYWdlIjoyfQ==
pageSizeinteger, [ 1 .. 1000 ](PageSize)

Maximum number of results to return per page.

Default:100
Example:pageSize=20
Payload
// No request payload

Responses

Success

Bodyapplication/json
listArray of objects(OIDCProviderList)required

A list of OIDC providers.

nextPageTokenstring, [ 1 .. 4096 ] characters(NextPageToken)

When paging through results, the NextPageToken indicates what page to read next. It is obtained from the previous call.

Example:"eyJsYXN0S2V5IjoiYWJjMTIzIn0="
Response
{ "list": [ { … } ], "nextPageToken": "eyJsYXN0S2V5IjoiYWJjMTIzIn0=" }
Was this page helpful?