OIDCProviderService_ListOIDCProvider

GET 
/auth/v3/sso/oidc/provider

OIDCProviderService_ListOIDCProvider

Request

Responses

200

A successful response.

application/json

Schema

Schema

apiVersion API Version

Default value: system.k8smgmt.io/v3

API Version of the OIDCProvider list resource

kind Kind

Default value: OIDCProviderList

Kind of the OIDCProvider list resource

metadata object
Metadata of the OIDCProvider list resource
count int64
offset int64
limit int64
items object[]
List of the OIDCProvider resources
Array [
apiVersion API Versionrequired
Default value: system.k8smgmt.io/v3
API Version of the OIDCProvider resource
kind Kindrequired
Default value: OIDCProvider
Kind of the OIDCProvider resource
metadata objectrequired
Metadata of the OIDCProvider resource
name Namerequired
name of the resource
displayName Display Name
display name of the resource
description Description
description of the resource
labels object
labels of the resource
property name* string
annotations object
annotations of the resource
property name* string
project Projectrequired
Project of the resource
organization Organization
Organization to which the resource belongs
partner Partner
Partner to which the resource belongs
id string
urlScope string
createdAt date-time
modifiedAt date-time
spec objectrequired
Spec of the OIDCProvider resource
providerName enumeration?
mapperUrl string
mapperFilename string
clientId string
clientSecret string
scopes string[]
issuerUrl string
authUrl string
tokenUrl string
requestedClaims object
predefined boolean
callbackUrl string
status object
Status of the resource
conditionType Condition Type
type of the status condition
conditionStatus Condition Status
Possible values: [StatusNotSet, StatusSubmitted, StatusOK, StatusFailed]
Default value: StatusNotSet
status of the condition
lastUpdated date-time
when the condition status is last updated
reason Reason
reason of the last condition status
]

Example (from schema)

{
  "apiVersion": "system.k8smgmt.io/v3",
  "kind": "OIDCProviderList",
  "metadata": {
    "count": "string",
    "offset": "string",
    "limit": "string"
  },
  "items": [
    {
      "apiVersion": "system.k8smgmt.io/v3",
      "kind": "OIDCProvider",
      "metadata": {
        "name": "some-name",
        "project": "defaultproject"
      },
      "spec": {
        "providerName": "string",
        "mapperUrl": "string",
        "mapperFilename": "string",
        "clientId": "string",
        "clientSecret": "string",
        "scopes": [
          "string"
        ],
        "issuerUrl": "string",
        "authUrl": "string",
        "tokenUrl": "string",
        "requestedClaims": {},
        "predefined": true,
        "callbackUrl": "string"
      },
      "status": {
        "conditionType": "string",
        "conditionStatus": "StatusNotSet",
        "lastUpdated": "2024-02-15T00:40:10.856Z",
        "reason": "string"
      }
    }
  ]
}

application/yaml

Schema

Schema

apiVersion API Version

Default value: system.k8smgmt.io/v3

API Version of the OIDCProvider list resource

kind Kind

Default value: OIDCProviderList

Kind of the OIDCProvider list resource

metadata object
Metadata of the OIDCProvider list resource
count int64
offset int64
limit int64
items object[]
List of the OIDCProvider resources
Array [
apiVersion API Versionrequired
Default value: system.k8smgmt.io/v3
API Version of the OIDCProvider resource
kind Kindrequired
Default value: OIDCProvider
Kind of the OIDCProvider resource
metadata objectrequired
Metadata of the OIDCProvider resource
name Namerequired
name of the resource
displayName Display Name
display name of the resource
description Description
description of the resource
labels object
labels of the resource
property name* string
annotations object
annotations of the resource
property name* string
project Projectrequired
Project of the resource
organization Organization
Organization to which the resource belongs
partner Partner
Partner to which the resource belongs
id string
urlScope string
createdAt date-time
modifiedAt date-time
spec objectrequired
Spec of the OIDCProvider resource
providerName enumeration?
mapperUrl string
mapperFilename string
clientId string
clientSecret string
scopes string[]
issuerUrl string
authUrl string
tokenUrl string
requestedClaims object
predefined boolean
callbackUrl string
status object
Status of the resource
conditionType Condition Type
type of the status condition
conditionStatus Condition Status
Possible values: [StatusNotSet, StatusSubmitted, StatusOK, StatusFailed]
Default value: StatusNotSet
status of the condition
lastUpdated date-time
when the condition status is last updated
reason Reason
reason of the last condition status
]

Example (from schema)

{
  "apiVersion": "system.k8smgmt.io/v3",
  "kind": "OIDCProviderList",
  "metadata": {
    "count": "string",
    "offset": "string",
    "limit": "string"
  },
  "items": [
    {
      "apiVersion": "system.k8smgmt.io/v3",
      "kind": "OIDCProvider",
      "metadata": {
        "name": "some-name",
        "project": "defaultproject"
      },
      "spec": {
        "providerName": "string",
        "mapperUrl": "string",
        "mapperFilename": "string",
        "clientId": "string",
        "clientSecret": "string",
        "scopes": [
          "string"
        ],
        "issuerUrl": "string",
        "authUrl": "string",
        "tokenUrl": "string",
        "requestedClaims": {},
        "predefined": true,
        "callbackUrl": "string"
      },
      "status": {
        "conditionType": "string",
        "conditionStatus": "StatusNotSet",
        "lastUpdated": "2024-02-15T00:40:10.857Z",
        "reason": "string"
      }
    }
  ]
}

403

Returned when the user does not have permission to access the resource.

application/json

Schema

Schema

any

application/yaml

Schema

Schema

any

404

Returned when the resource does not exist.

application/json

Schema

Schema

string

application/yaml

Schema

Schema

string

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/yaml

Schema

Schema

code int32
message string
details object[]
Array [
@type string
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...