Add an IDP authenticator to a user

Add a new identity provider (IDP) authenticator to an existing user. This will allow the user to authenticate with the provided IDP.

Path Parameters

userId string required

unique identifier of the user.

application/json

application/grpc

application/grpc-web+proto

Request Body required

idpAuthenticator object

idpId ID of the identity provider required

Possible values: non-empty and <= 200 characters

userId ID of the user provided by the identity provider required

Possible values: non-empty and <= 200 characters

userName string required

Possible values: non-empty and <= 200 characters

Username of the user provided by the identity provider.

Request Body required

idpAuthenticator object

idpId ID of the identity provider required

Possible values: non-empty and <= 200 characters

userId ID of the user provided by the identity provider required

Possible values: non-empty and <= 200 characters

userName string required

Possible values: non-empty and <= 200 characters

Username of the user provided by the identity provider.

Request Body required

idpAuthenticator object

idpId ID of the identity provider required

Possible values: non-empty and <= 200 characters

userId ID of the user provided by the identity provider required

Possible values: non-empty and <= 200 characters

userName string required

Possible values: non-empty and <= 200 characters

Username of the user provided by the identity provider.

Responses

• 200
• 403
• 404
• default

---

IDP authenticator successfully added

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-04-09T11:59:29.215Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-04-09T11:59:29.215Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-04-09T11:59:29.215Z",
    "resourceOwner": "69629023906488334"
  }
}

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

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Returned when the resource does not exist.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

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

POST /v3alpha/users/:userId/idps

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL

https://$CUSTOM-DOMAIN

Bearer Token

userId — path required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "idpAuthenticator": {
    "idpId": "69629026806489455",
    "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userName": "user@external.com"
  }
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/idps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpAuthenticator": {
    "idpId": "69629026806489455",
    "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userName": "user@external.com"
  }
}'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/idps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpAuthenticator": {
    "idpId": "69629026806489455",
    "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userName": "user@external.com"
  }
}'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/idps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpAuthenticator": {
    "idpId": "69629026806489455",
    "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userName": "user@external.com"
  }
}'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/idps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpAuthenticator": {
    "idpId": "69629026806489455",
    "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userName": "user@external.com"
  }
}'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/idps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpAuthenticator": {
    "idpId": "69629026806489455",
    "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userName": "user@external.com"
  }
}'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/idps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpAuthenticator": {
    "idpId": "69629026806489455",
    "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userName": "user@external.com"
  }
}'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/idps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpAuthenticator": {
    "idpId": "69629026806489455",
    "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userName": "user@external.com"
  }
}'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/idps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpAuthenticator": {
    "idpId": "69629026806489455",
    "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userName": "user@external.com"
  }
}'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/v3alpha/users/:userId/idps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "idpAuthenticator": {
    "idpId": "69629026806489455",
    "userId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
    "userName": "user@external.com"
  }
}'