Initial Setup Steps for Identity Provisioning with GitHub

This page describes the initial setup steps for using TrustLogin as the source of identity
to perform Identity Provisioning to GitHub.

Note: For detailed instructions on operating GitHub, please refer to the manual provided by GitHub.

Item Details

Pre-check

  • GitHub administrator privileges are required.

Setup Flow / Manual

Note: After connecting TrustLogin and GitHub using the steps on this page,
 please proceed to configuring user synchronization.

Provisioning Target

Supports user provisioning

Supports group provisioning

SAML Authentication Setup Manual

GitHub SAML JIT Setup Guide

  • The Identity Provisioning configuration created in this procedure can be linked to an existing SAML app.
    For details on SAML app configuration, please see here.
  • To prevent conflicts in user attribute updates caused by using Identity Provisioning together with SAML JIT,
    we recommend not configuring the "SAML Attribute Settings" for duplicate user attributes when creating a SAML app.
    Note: Behavior depends on the service specifications, so please check with each SP for details.

Notes

  • None in particular

Setup Steps

GitHub Settings

  1. Log in to GitHub with administrator privileges, and click "Setting" from the profile icon in the upper right of the screen.
    github_IDProv_01.png
  2. From "Developer Setting", go to the developer settings page,
    and select "Personal access tokens > Tokens (classic)".
    github_IDProv_02.png
  3. Click the "Generate new token > Generate new token (classic)" button.
    github_IDProv_03.png
  4. Enter any name in the Note field,
    and check "scim:enterprise" under "admin:enterprise".
    github_IDProv_05.png

  5. Click "Generate token" to generate the token.
    github_IDProv_06.png

  6. Copy and save the displayed token.
    Note: You will not be able to view the token again after "Save". Please make sure not to miss copying it.
    github_IDProv_07.png

  7. Click "Enterprise" from the profile icon,
    and check the "Identity provider tab > Single sign-on configuration > Open SCIM Configuration" item.
    If "Enable open SCIM configuration" is OFF, change it to ON.
    github_IDProv_08.png

    This completes the preparation on the GitHub side. Next, configure the settings on the TrustLogin side.

TrustLogin Settings

  1. Log in to the TrustLogin Admin Page, and from the "Admin Page > Settings > Optional Features" menu,
    open "Settings" next to "Identity Provisioning".
    IDProvServiceCommon01.png

  2. Click "Add Service".
    IDProvServiceCommon02.png

  3. On the Add Service screen, search for and select "GitHub", then click the "Add" button.
    IDProvServiceCommon03.png
  4. You will be redirected to the "Identity Provisioning > GitHub" page.
    Click the "Edit" button to open "Access Settings", enter the following values for the settings items, and click "Save".

    Connection URL

    https://api.github.com/scim/v2/enterprises/{org}

    Note: Replace {org} with the name of the organization you are connecting.

    Access Token GitHub Settings The value of the token you copied in step 7

    zen_IDProv_02.png

  5. Click the "Connect" button in the upper right of the screen.
    zen_IDProv_03.png

  6. Once the button status updates to "Connected", the initial setup is complete.
    Connected_IDProv.png

Next step: The manual for configuring user synchronization is available here

Values You Can Configure in Attribute Mapping

The following values can be specified as default functions for GitHub.

Value Description
Full Name The full name with the surname first.
Full Name (Given Name First) The full name with the given name first.
Username from Email Takes the portion of the email before the "@" and limits it to a maximum of 21 characters.
Format the phone number to E.164 format. Converts the phone number to E.164 format (an international format that includes the country code with a + sign).
Username from Email (Remove Special Characters) Generates a username from the user’s email address.
Extracts the local part and removes invalid characters (only letters, numbers, and underscores (_) are allowed).

Note: For an overview of the attribute mapping feature and how to configure it, please see here.


Initial Setup Steps for Identity Provisioning with GitHub

This page describes the initial setup steps for using TrustLogin as the source of identity
to perform Identity Provisioning to GitHub.

Note: For detailed instructions on operating GitHub, please refer to the manual provided by GitHub.

Item Details

Pre-check

  • GitHub administrator privileges are required.

Setup Flow / Manual

Note: After connecting TrustLogin and GitHub using the steps on this page,
 please proceed to configuring user synchronization.

Provisioning Target

Supports user provisioning

Supports group provisioning

SAML Authentication Setup Manual

GitHub SAML JIT Setup Guide

  • The Identity Provisioning configuration created in this procedure can be linked to an existing SAML app.
    For details on SAML app configuration, please see here.
  • To prevent conflicts in user attribute updates caused by using Identity Provisioning together with SAML JIT,
    we recommend not configuring the "SAML Attribute Settings" for duplicate user attributes when creating a SAML app.
    Note: Behavior depends on the service specifications, so please check with each SP for details.

Notes

  • None in particular

Setup Steps

GitHub Settings

  1. Log in to GitHub with administrator privileges, and click "Setting" from the profile icon in the upper right of the screen.
    github_IDProv_01.png
  2. From "Developer Setting", go to the developer settings page,
    and select "Personal access tokens > Tokens (classic)".
    github_IDProv_02.png
  3. Click the "Generate new token > Generate new token (classic)" button.
    github_IDProv_03.png
  4. Enter any name in the Note field,
    and check "scim:enterprise" under "admin:enterprise".
    github_IDProv_05.png

  5. Click "Generate token" to generate the token.
    github_IDProv_06.png

  6. Copy and save the displayed token.
    Note: You will not be able to view the token again after "Save". Please make sure not to miss copying it.
    github_IDProv_07.png

  7. Click "Enterprise" from the profile icon,
    and check the "Identity provider tab > Single sign-on configuration > Open SCIM Configuration" item.
    If "Enable open SCIM configuration" is OFF, change it to ON.
    github_IDProv_08.png

    This completes the preparation on the GitHub side. Next, configure the settings on the TrustLogin side.

TrustLogin Settings

  1. Log in to the TrustLogin Admin Page, and from the "Admin Page > Settings > Optional Features" menu,
    open "Settings" next to "Identity Provisioning".
    IDProvServiceCommon01.png

  2. Click "Add Service".
    IDProvServiceCommon02.png

  3. On the Add Service screen, search for and select "GitHub", then click the "Add" button.
    IDProvServiceCommon03.png
  4. You will be redirected to the "Identity Provisioning > GitHub" page.
    Click the "Edit" button to open "Access Settings", enter the following values for the settings items, and click "Save".

    Connection URL

    https://api.github.com/scim/v2/enterprises/{org}

    Note: Replace {org} with the name of the organization you are connecting.

    Access Token GitHub Settings The value of the token you copied in step 7

    zen_IDProv_02.png

  5. Click the "Connect" button in the upper right of the screen.
    zen_IDProv_03.png

  6. Once the button status updates to "Connected", the initial setup is complete.
    Connected_IDProv.png

Next step: The manual for configuring user synchronization is available here

Values You Can Configure in Attribute Mapping

The following values can be specified as default functions for GitHub.

Value Description
Full Name The full name with the surname first.
Full Name (Given Name First) The full name with the given name first.
Username from Email Takes the portion of the email before the "@" and limits it to a maximum of 21 characters.
Format the phone number to E.164 format. Converts the phone number to E.164 format (an international format that includes the country code with a + sign).
Username from Email (Remove Special Characters) Generates a username from the user’s email address.
Extracts the local part and removes invalid characters (only letters, numbers, and underscores (_) are allowed).

Note: For an overview of the attribute mapping feature and how to configure it, please see here.