Get the current active identity providers

GET 
/v2/settings/login/idps

Return the current active identity providers for the requested context

Request

Query Parameters

ctx.orgId string
ctx.instance boolean

Responses

200

OK

application/json

Schema

Schema

details

object

totalResult uint64

processedSequence uint64

timestamp date-time

the last time the projection got updated

identityProviders

object[]

Array [

id string

name string

type string

Possible values: [IDENTITY_PROVIDER_TYPE_UNSPECIFIED, IDENTITY_PROVIDER_TYPE_OIDC, IDENTITY_PROVIDER_TYPE_JWT, IDENTITY_PROVIDER_TYPE_LDAP, IDENTITY_PROVIDER_TYPE_OAUTH, IDENTITY_PROVIDER_TYPE_AZURE_AD, IDENTITY_PROVIDER_TYPE_GITHUB, IDENTITY_PROVIDER_TYPE_GITHUB_ES, IDENTITY_PROVIDER_TYPE_GITLAB, IDENTITY_PROVIDER_TYPE_GITLAB_SELF_HOSTED, IDENTITY_PROVIDER_TYPE_GOOGLE, IDENTITY_PROVIDER_TYPE_SAML, IDENTITY_PROVIDER_TYPE_APPLE]

Default value: IDENTITY_PROVIDER_TYPE_UNSPECIFIED

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "timestamp": "2024-11-22T16:27:05.245Z"
  },
  "identityProviders": [
    {
      "id": "string",
      "name": "string",
      "type": "IDENTITY_PROVIDER_TYPE_UNSPECIFIED"
    }
  ]
}

application/grpc

Schema

Schema

details

object

totalResult uint64

processedSequence uint64

timestamp date-time

the last time the projection got updated

identityProviders

object[]

Array [

id string

name string

type string

Possible values: [IDENTITY_PROVIDER_TYPE_UNSPECIFIED, IDENTITY_PROVIDER_TYPE_OIDC, IDENTITY_PROVIDER_TYPE_JWT, IDENTITY_PROVIDER_TYPE_LDAP, IDENTITY_PROVIDER_TYPE_OAUTH, IDENTITY_PROVIDER_TYPE_AZURE_AD, IDENTITY_PROVIDER_TYPE_GITHUB, IDENTITY_PROVIDER_TYPE_GITHUB_ES, IDENTITY_PROVIDER_TYPE_GITLAB, IDENTITY_PROVIDER_TYPE_GITLAB_SELF_HOSTED, IDENTITY_PROVIDER_TYPE_GOOGLE, IDENTITY_PROVIDER_TYPE_SAML, IDENTITY_PROVIDER_TYPE_APPLE]

Default value: IDENTITY_PROVIDER_TYPE_UNSPECIFIED

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "timestamp": "2024-11-22T16:27:05.246Z"
  },
  "identityProviders": [
    {
      "id": "string",
      "name": "string",
      "type": "IDENTITY_PROVIDER_TYPE_UNSPECIFIED"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

details

object

totalResult uint64

processedSequence uint64

timestamp date-time

the last time the projection got updated

identityProviders

object[]

Array [

id string

name string

type string

Possible values: [IDENTITY_PROVIDER_TYPE_UNSPECIFIED, IDENTITY_PROVIDER_TYPE_OIDC, IDENTITY_PROVIDER_TYPE_JWT, IDENTITY_PROVIDER_TYPE_LDAP, IDENTITY_PROVIDER_TYPE_OAUTH, IDENTITY_PROVIDER_TYPE_AZURE_AD, IDENTITY_PROVIDER_TYPE_GITHUB, IDENTITY_PROVIDER_TYPE_GITHUB_ES, IDENTITY_PROVIDER_TYPE_GITLAB, IDENTITY_PROVIDER_TYPE_GITLAB_SELF_HOSTED, IDENTITY_PROVIDER_TYPE_GOOGLE, IDENTITY_PROVIDER_TYPE_SAML, IDENTITY_PROVIDER_TYPE_APPLE]

Default value: IDENTITY_PROVIDER_TYPE_UNSPECIFIED

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "timestamp": "2024-11-22T16:27:05.246Z"
  },
  "identityProviders": [
    {
      "id": "string",
      "name": "string",
      "type": "IDENTITY_PROVIDER_TYPE_UNSPECIFIED"
    }
  ]
}

403

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

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "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/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

Loading...