List Social Logins

POST 
/users/me/idps/_search

Returns a list of all linked identity providers/social logins of the user. (e. Google, Microsoft, AzureAD, etc.)

Request

application/json

Body

required

query

object

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

application/grpc

Body

required

query

object

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

application/grpc-web+proto

Body

required

query

object

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

Responses

200

A successful response.

application/json

Schema

Schema

details

object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

result

object[]

Array [

userId string

the id of the user

idpId string

the id of the identity provider

idpName string

the name of the identity provider

providedUserId string

the id of the user provided by the identity provider

providedUserName string

the id of the identity provider

idpType authorization framework of the identity provider (string)

Possible values: [IDP_TYPE_UNSPECIFIED, IDP_TYPE_OIDC, IDP_TYPE_JWT]

Default value: IDP_TYPE_UNSPECIFIED

the authorization framework of the identity provider

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-07-03T07:44:29.401Z"
  },
  "result": [
    {
      "userId": "69629023906488334",
      "idpId": "69629023906488334",
      "idpName": "google",
      "providedUserId": "as-12-df-89",
      "providedUserName": "gigi.long-neck@gmail.com",
      "idpType": "IDP_TYPE_UNSPECIFIED"
    }
  ]
}

application/grpc

Schema

Schema

details

object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

result

object[]

Array [

userId string

the id of the user

idpId string

the id of the identity provider

idpName string

the name of the identity provider

providedUserId string

the id of the user provided by the identity provider

providedUserName string

the id of the identity provider

idpType authorization framework of the identity provider (string)

Possible values: [IDP_TYPE_UNSPECIFIED, IDP_TYPE_OIDC, IDP_TYPE_JWT]

Default value: IDP_TYPE_UNSPECIFIED

the authorization framework of the identity provider

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-07-03T07:44:29.401Z"
  },
  "result": [
    {
      "userId": "69629023906488334",
      "idpId": "69629023906488334",
      "idpName": "google",
      "providedUserId": "as-12-df-89",
      "providedUserName": "gigi.long-neck@gmail.com",
      "idpType": "IDP_TYPE_UNSPECIFIED"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

details

object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

result

object[]

Array [

userId string

the id of the user

idpId string

the id of the identity provider

idpName string

the name of the identity provider

providedUserId string

the id of the user provided by the identity provider

providedUserName string

the id of the identity provider

idpType authorization framework of the identity provider (string)

Possible values: [IDP_TYPE_UNSPECIFIED, IDP_TYPE_OIDC, IDP_TYPE_JWT]

Default value: IDP_TYPE_UNSPECIFIED

the authorization framework of the identity provider

]

Example (from schema)

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-07-03T07:44:29.402Z"
  },
  "result": [
    {
      "userId": "69629023906488334",
      "idpId": "69629023906488334",
      "idpName": "google",
      "providedUserId": "as-12-df-89",
      "providedUserName": "gigi.long-neck@gmail.com",
      "idpType": "IDP_TYPE_UNSPECIFIED"
    }
  ]
}

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...