ZITADEL Docs
APIsCore ResourcesV2User

RetrieveIdentityProviderIntent

Retrieve the information returned by the identity provider

Retrieve the information returned by the identity provider for registration or updating an existing user with new information..

POST
/v2/idp_intents/{idp_intent_id}

Path Parameters

idp_intent_id*string

Request Body

application/json

idpIntentToken?string
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/v2/idp_intents/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "sequence": 0,
    "changeDate": "1s",
    "resourceOwner": "string",
    "creationDate": "1s"
  },
  "idpInformation": {
    "idpId": "string",
    "userId": "string",
    "userName": "string",
    "rawInformation": {
      "property1": {},
      "property2": {}
    },
    "ldap": {
      "attributes": {
        "property1": {},
        "property2": {}
      }
    }
  },
  "userId": "string",
  "addHumanUser": {
    "userId": "string",
    "username": "string",
    "organization": {
      "orgDomain": "string"
    },
    "profile": {
      "givenName": "string",
      "familyName": "string",
      "nickName": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "gender": "GENDER_UNSPECIFIED"
    },
    "email": {
      "email": "string",
      "isVerified": true
    },
    "phone": {
      "phone": "string",
      "isVerified": true
    },
    "metadata": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "idpLinks": [
      {
        "idpId": "string",
        "userId": "string",
        "userName": "string"
      }
    ],
    "totpSecret": "string",
    "hashedPassword": {
      "hash": "string",
      "changeRequired": true
    }
  },
  "updateHumanUser": {
    "userId": "string",
    "username": "string",
    "profile": {
      "givenName": "string",
      "familyName": "string",
      "nickName": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "gender": "GENDER_UNSPECIFIED"
    },
    "email": {
      "email": "string",
      "isVerified": true
    },
    "phone": {
      "phone": "string",
      "isVerified": true
    },
    "password": {
      "hashedPassword": {
        "hash": "string",
        "changeRequired": true
      },
      "currentPassword": "string"
    }
  }
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?