Get v1idps 1

cURL

curl --request GET \
  --url https://api.example.com/v1/idps/{idp}

{
  "name": "<string>",
  "title": "<string>",
  "domain": "<string>",
  "type": "IDENTITY_PROVIDER_TYPE_UNSPECIFIED",
  "config": {
    "oauth2Config": {
      "authUrl": "<string>",
      "tokenUrl": "<string>",
      "userInfoUrl": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "scopes": [
        "<string>"
      ],
      "fieldMapping": {
        "identifier": "<string>",
        "displayName": "<string>",
        "phone": "<string>",
        "groups": "<string>"
      },
      "skipTlsVerify": true,
      "authStyle": "OAUTH2_AUTH_STYLE_UNSPECIFIED"
    },
    "oidcConfig": {
      "issuer": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "scopes": [
        "<string>"
      ],
      "fieldMapping": {
        "identifier": "<string>",
        "displayName": "<string>",
        "phone": "<string>",
        "groups": "<string>"
      },
      "skipTlsVerify": true,
      "authStyle": "OAUTH2_AUTH_STYLE_UNSPECIFIED",
      "authEndpoint": "<string>"
    },
    "ldapConfig": {
      "host": "<string>",
      "port": 123,
      "skipTlsVerify": true,
      "bindDn": "<string>",
      "bindPassword": "<string>",
      "baseDn": "<string>",
      "userFilter": "<string>",
      "securityProtocol": "SECURITY_PROTOCOL_UNSPECIFIED",
      "fieldMapping": {
        "identifier": "<string>",
        "displayName": "<string>",
        "phone": "<string>",
        "groups": "<string>"
      }
    }
  }
}

GET

idps

{idp}

cURL

curl --request GET \
  --url https://api.example.com/v1/idps/{idp}

{
  "name": "<string>",
  "title": "<string>",
  "domain": "<string>",
  "type": "IDENTITY_PROVIDER_TYPE_UNSPECIFIED",
  "config": {
    "oauth2Config": {
      "authUrl": "<string>",
      "tokenUrl": "<string>",
      "userInfoUrl": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "scopes": [
        "<string>"
      ],
      "fieldMapping": {
        "identifier": "<string>",
        "displayName": "<string>",
        "phone": "<string>",
        "groups": "<string>"
      },
      "skipTlsVerify": true,
      "authStyle": "OAUTH2_AUTH_STYLE_UNSPECIFIED"
    },
    "oidcConfig": {
      "issuer": "<string>",
      "clientId": "<string>",
      "clientSecret": "<string>",
      "scopes": [
        "<string>"
      ],
      "fieldMapping": {
        "identifier": "<string>",
        "displayName": "<string>",
        "phone": "<string>",
        "groups": "<string>"
      },
      "skipTlsVerify": true,
      "authStyle": "OAUTH2_AUTH_STYLE_UNSPECIFIED",
      "authEndpoint": "<string>"
    },
    "ldapConfig": {
      "host": "<string>",
      "port": 123,
      "skipTlsVerify": true,
      "bindDn": "<string>",
      "bindPassword": "<string>",
      "baseDn": "<string>",
      "userFilter": "<string>",
      "securityProtocol": "SECURITY_PROTOCOL_UNSPECIFIED",
      "fieldMapping": {
        "identifier": "<string>",
        "displayName": "<string>",
        "phone": "<string>",
        "groups": "<string>"
      }
    }
  }
}

Path Parameters

idp

string

required

The idp id.

Response

name

string

The name of the identity provider. Format: idps/{idp}

title

string

The display title of the identity provider.

domain

string

The domain for email matching when using this identity provider.

type

enum<string>

The type of identity provider protocol.

Available options:

IDENTITY_PROVIDER_TYPE_UNSPECIFIED,

OAUTH2,

OIDC,

LDAP

config

object

The configuration details for the identity provider.

Show child attributes

config.oauth2Config

object

OAuth2 protocol configuration.

Show child attributes

config.oauth2Config.authUrl

string

The authorization endpoint URL for OAuth2 flow.

config.oauth2Config.tokenUrl

string

The token endpoint URL for exchanging authorization code.

config.oauth2Config.userInfoUrl

string

The user information endpoint URL.

config.oauth2Config.clientId

string

The OAuth2 client identifier.

config.oauth2Config.clientSecret

string

The OAuth2 client secret for authentication.

config.oauth2Config.scopes

string[]

The list of OAuth2 scopes to request.

config.oauth2Config.fieldMapping

object

Mapping configuration for user attributes from OAuth2 response.

Show child attributes

config.oauth2Config.fieldMapping.identifier

string

Identifier is the field name of the unique identifier in 3rd-party idp user info. Required.

config.oauth2Config.fieldMapping.displayName

string

DisplayName is the field name of display name in 3rd-party idp user info. Optional.

config.oauth2Config.fieldMapping.phone

string

Phone is the field name of primary phone in 3rd-party idp user info. Optional.

config.oauth2Config.fieldMapping.groups

string

Groups is the field name of groups in 3rd-party idp user info. Optional. Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/

config.oauth2Config.skipTlsVerify

boolean

Whether to skip TLS certificate verification.

config.oauth2Config.authStyle

enum<string>

The authentication style for client credentials.

Available options:

OAUTH2_AUTH_STYLE_UNSPECIFIED,

IN_PARAMS,

IN_HEADER

config.oidcConfig

object

OIDC protocol configuration.

Show child attributes

config.oidcConfig.issuer

string

The OIDC issuer URL for the identity provider.

config.oidcConfig.clientId

string

The OIDC client identifier.

config.oidcConfig.clientSecret

string

The OIDC client secret for authentication.

config.oidcConfig.scopes

string[]

The scopes that the OIDC provider supports. Should be fetched from the well-known configuration file of the OIDC provider.

config.oidcConfig.fieldMapping

object

Mapping configuration for user attributes from OIDC claims.

Show child attributes

config.oidcConfig.fieldMapping.identifier

string

Identifier is the field name of the unique identifier in 3rd-party idp user info. Required.

config.oidcConfig.fieldMapping.displayName

string

DisplayName is the field name of display name in 3rd-party idp user info. Optional.

config.oidcConfig.fieldMapping.phone

string

Phone is the field name of primary phone in 3rd-party idp user info. Optional.

config.oidcConfig.fieldMapping.groups

string

Groups is the field name of groups in 3rd-party idp user info. Optional. Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/

config.oidcConfig.skipTlsVerify

boolean

Whether to skip TLS certificate verification.

config.oidcConfig.authStyle

enum<string>

The authentication style for client credentials.

Available options:

OAUTH2_AUTH_STYLE_UNSPECIFIED,

IN_PARAMS,

IN_HEADER

config.oidcConfig.authEndpoint

string

The authorization endpoint of the OIDC provider. Should be fetched from the well-known configuration file of the OIDC provider.

config.ldapConfig

object

LDAP protocol configuration.

Show child attributes

config.ldapConfig.host

string

Host is the hostname or IP address of the LDAP server, e.g., "ldap.example.com".

config.ldapConfig.port

integer<int32>

Port is the port number of the LDAP server, e.g., 389. When not set, the default port of the corresponding security protocol will be used, i.e. 389 for StartTLS and 636 for LDAPS.

config.ldapConfig.skipTlsVerify

boolean

SkipTLSVerify controls whether to skip TLS certificate verification.

config.ldapConfig.bindDn

string

BindDN is the DN of the user to bind as a service account to perform search requests.

config.ldapConfig.bindPassword

string

BindPassword is the password of the user to bind as a service account.

config.ldapConfig.baseDn

string

BaseDN is the base DN to search for users, e.g., "ou=users,dc=example,dc=com".

config.ldapConfig.userFilter

string

UserFilter is the filter to search for users, e.g., "(uid=%s)".

config.ldapConfig.securityProtocol

enum<string>

SecurityProtocol is the security protocol to be used for establishing connections with the LDAP server.

Available options:

SECURITY_PROTOCOL_UNSPECIFIED,

START_TLS,

LDAPS

config.ldapConfig.fieldMapping

object

FieldMapping is the mapping of the user attributes returned by the LDAP server.

Show child attributes

config.ldapConfig.fieldMapping.identifier

string

Identifier is the field name of the unique identifier in 3rd-party idp user info. Required.

config.ldapConfig.fieldMapping.displayName

string

DisplayName is the field name of display name in 3rd-party idp user info. Optional.

config.ldapConfig.fieldMapping.phone

string

Phone is the field name of primary phone in 3rd-party idp user info. Optional.

config.ldapConfig.fieldMapping.groups

string

Groups is the field name of groups in 3rd-party idp user info. Optional. Mainly used for OIDC: https://developer.okta.com/docs/guides/customize-tokens-groups-claim/main/

Post v1idps*:test Delete v1idps

ProjectService

ActuatorService

AuditLogService

AuthService

CelService

OrgPolicyService

GroupService

IdentityProviderService

InstanceService

DatabaseService

DatabaseCatalogService

RevisionService

SQLService

InstanceRoleService

DatabaseGroupService

IssueService

PlanService

ReleaseService

RolloutService

SheetService

ReviewConfigService

RoleService

SettingService

SubscriptionService

UserService

WorksheetService

WorkspaceService

Path Parameters

Response