Skip to content

List

GET
/api/web/custom/namespaces/{namespace}/oidc_providers
curl --request GET \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/custom/namespaces/example/oidc_providers \
--header 'Authorization: <Authorization>'

List implements OIDC provider query. Returns list of OIDC provider of all types. Query will look into current tenants system namespace.

Examples of this operation.

namespace
required
string

Namespace Supports only system namespace.

A successful response.

Media typeapplication/json
ListResponse

Format of the response body to list OIDC providers configured for the tenant under a namespace.

object
items
items

List of OIDC providers.

Array<object>
List response item

Shape of the OIDC provider object in a list request’s response body.

object
create_timestamp
create timestamp

Create timestamp of the OIDC provider object.

string format: date-time
<= 1024 characters
name
name

Name of OIDC provider.

string
>= 6 characters <= 1024 characters
namespace
namespace

Namespace of OIDC provider object.

string
>= 6 characters <= 1024 characters
provider_type
string
default: DEFAULT
Allowed values: DEFAULT GOOGLE AZURE OKTA
uid
uid

UID of OIDC provider object.

string format: uuid
>= 36 characters <= 1024 characters
Example
{
"items": [
{
"provider_type": "DEFAULT"
}
]
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example