Update Azure AD Identity Provider​
Update Azure AD Identity Provider
Path Parameters
Request Body required
Client id generated by the Azure AD
Client_secret will only be updated if provided
tenant object
Azure AD doesn't send if the email has been verified. Enable this if the user email should always be added verified in ZITADEL (no verification emails will be sent)
the scopes requested by ZITADEL during the request to Azure AD
providerOptions object
Request Body required
Client id generated by the Azure AD
Client_secret will only be updated if provided
tenant object
Azure AD doesn't send if the email has been verified. Enable this if the user email should always be added verified in ZITADEL (no verification emails will be sent)
the scopes requested by ZITADEL during the request to Azure AD
providerOptions object
Request Body required
Client id generated by the Azure AD
Client_secret will only be updated if provided
tenant object
Azure AD doesn't send if the email has been verified. Enable this if the user email should always be added verified in ZITADEL (no verification emails will be sent)
the scopes requested by ZITADEL during the request to Azure AD
providerOptions object
- 200
- default
A successful response.
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:51.434Z",
"changeDate": "2024-03-27T10:05:51.434Z",
"resourceOwner": "69629023906488334"
}
}
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:51.435Z",
"changeDate": "2024-03-27T10:05:51.435Z",
"resourceOwner": "69629023906488334"
}
}
Schema
details object
{
"details": {
"sequence": "2",
"creationDate": "2024-03-27T10:05:51.435Z",
"changeDate": "2024-03-27T10:05:51.435Z",
"resourceOwner": "69629023906488334"
}
}
An unexpected error response.
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
PUT /idps/azure/:id
Authorization
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "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
Request
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/idps/azure/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"name": "Azure AD",
"clientId": "client-id",
"clientSecret": "secret",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
],
"providerOptions": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true
}
}'
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/idps/azure/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"name": "Azure AD",
"clientId": "client-id",
"clientSecret": "secret",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
],
"providerOptions": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true
}
}'
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/idps/azure/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"name": "Azure AD",
"clientId": "client-id",
"clientSecret": "secret",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
],
"providerOptions": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true
}
}'
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/idps/azure/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"name": "Azure AD",
"clientId": "client-id",
"clientSecret": "secret",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
],
"providerOptions": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true
}
}'
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/idps/azure/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"name": "Azure AD",
"clientId": "client-id",
"clientSecret": "secret",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
],
"providerOptions": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true
}
}'
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/idps/azure/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"name": "Azure AD",
"clientId": "client-id",
"clientSecret": "secret",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
],
"providerOptions": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true
}
}'
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/idps/azure/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"name": "Azure AD",
"clientId": "client-id",
"clientSecret": "secret",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
],
"providerOptions": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true
}
}'
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/idps/azure/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"name": "Azure AD",
"clientId": "client-id",
"clientSecret": "secret",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
],
"providerOptions": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true
}
}'
curl -L -X PUT 'https://$CUSTOM-DOMAIN/management/v1/idps/azure/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"name": "Azure AD",
"clientId": "client-id",
"clientSecret": "secret",
"tenant": {
"tenantType": "AZURE_AD_TENANT_TYPE_COMMON",
"tenantId": "string"
},
"emailVerified": true,
"scopes": [
"openid",
"profile",
"email",
"User.Read"
],
"providerOptions": {
"isLinkingAllowed": true,
"isCreationAllowed": true,
"isAutoCreation": true,
"isAutoUpdate": true
}
}'