Skip to main content

Update GitHub Enterprise Identity Provider

PUT 

https://$CUSTOM-DOMAIN/admin/v1/idps/github_es/:id

Update GitHub Enterprise Identity Provider

Request​

Path Parameters

    id stringrequired

Bodyrequired

    namestring
    Example: GitHub
    clientIdstring

    Client id generated by GitHub

    Example: client-id
    clientSecretclient_secret will only be updated if provided (string)

    Client secret will only be updated if provided

    Example: secret
    authorizationEndpointstring
    tokenEndpointstring
    userEndpointstring
    scopesstring[]

    The scopes requested by ZITADEL during the request to GitHub

    Example: ["openid","profile","email"]
    providerOptions object
    isLinkingAllowedboolean

    Enable if users should be able to manually link an existing ZITADEL user with an external account. Disable if users should only be allowed to link the proposed account in case of active auto_linking.

    isCreationAllowedboolean

    Enable if users should be able to manually create a new account in ZITADEL when using an external account. Disable if users should not be able to edit account information when auto_creation is enabled.

    isAutoCreationboolean

    Enable if a new account in ZITADEL should be created automatically when login with an external account.

    isAutoUpdateboolean

    Enable if a the ZITADEL account fields should be updated automatically on each login.

    autoLinkingstring

    Enable if users should get prompted to link an existing ZITADEL user to an external account if the selected attribute matches.

    Possible values: [AUTO_LINKING_OPTION_UNSPECIFIED, AUTO_LINKING_OPTION_USERNAME, AUTO_LINKING_OPTION_EMAIL]

    Default value: AUTO_LINKING_OPTION_UNSPECIFIED

Responses​

A successful response.

Schema
    details object
    sequenceuint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    Example: 2
    creationDatedate-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDatedate-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwnerresource_owner is the organization an object belongs to (string)
    Example: 69629023906488334

Authorization: oauth2

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 Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Parameters
— pathrequired
Body required
{
  "name": "GitHub",
  "clientId": "client-id",
  "clientSecret": "secret",
  "authorizationEndpoint": "string",
  "tokenEndpoint": "string",
  "userEndpoint": "string",
  "scopes": [
    "openid",
    "profile",
    "email"
  ],
  "providerOptions": {
    "isLinkingAllowed": true,
    "isCreationAllowed": true,
    "isAutoCreation": true,
    "isAutoUpdate": true,
    "autoLinking": "AUTO_LINKING_OPTION_UNSPECIFIED"
  }
}
ResponseClear

Click the Send API Request button above and see the response here!