Skip to main content
logoTetrate Service BridgeVersion: next

OIDC Service

Service to manage OIDC configurations in TSB.

OIDCs

The OIDC service provides methods to manage OIDC configurations in TSB. OIDC configurations allow users to authenticate using external identity providers that support the OpenID Connect protocol. Multiple OIDC configurations can be created within an organization to support different identity providers.

CreateOIDC

GetOIDC

UpdateOIDC

ListOIDCs

DeleteOIDC

CreateOIDCRequest

Request to create an OIDC configuration.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource where the OIDC configuration will be created.

string = {
  min_len: 1
}

name

string
REQUIRED
The short name for the resource to be created.

string = {
  min_len: 1
  max_len: 63
  pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
}

oidc

tetrateio.api.tsb.v2.OIDC
REQUIRED
Details of the OIDC configuration to be created.

message = {
  required: true
}

DeleteOIDCRequest

Request to delete an OIDC configuration.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the OIDC configuration.

string = {
  min_len: 1
}

force

bool
Force the deletion of the object even if deletion protection is enabled.

GetOIDCRequest

Request to retrieve an OIDC configuration.

FieldDescriptionValidation Rule

fqn

string
REQUIRED
Fully-qualified name of the OIDC configuration.

string = {
  min_len: 1
}

ListOIDCsRequest

Request to list OIDC configurations.

FieldDescriptionValidation Rule

parent

string
REQUIRED
Parent resource to list OIDC configurations from.

string = {
  min_len: 1
}

ListOIDCsResponse

List of OIDC configurations.

FieldDescriptionValidation Rule

oidcs

List of tetrateio.api.tsb.v2.OIDC
The list of OIDC configurations.