Qodex.ai

List SCIM provisioned identities

GET {{baseUrl}}/scim/v2/organizations/:org/Users?startIndex=<integer>&count=<integer>&filter=<string>

Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the filter parameter, the resources for all matching provisions members are returned.

When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member: - When a user with a SCIM-provisioned external identity is removed from an organization, the account's metadata is preserved to allow the user to re-join the organization in the future. - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted). - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO.

The returned list of external identities can include an entry for a null user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:

  1. The user is granted access by the IdP and is not a member of the GitHub organization.

  2. The user attempts to access the GitHub organization and initiates the SAML SSO process, and is not currently signed in to their GitHub account.

  3. After successfully authenticating with the SAML SSO IdP, the null external identity entry is created and the user is prompted to sign in to their GitHub account:

    • If the user signs in, their GitHub account is linked to this entry.
    • If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub organization, and the external identity null entry remains in place.

Request Params

KeyDatatypeRequiredDescription
startIndexstringUsed for pagination: the index of the first result to return.
countstringUsed for pagination: the number of results to return.
filterstringFilters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query:

?filter=userName%20eq%20\&quot;Octocat\&quot;.

To filter results for for the identity with the email octocat@github.com, you would use this query:

?filter=emails%20eq%20\&quot;octocat@github.com\&quot;. |

RESPONSES

status: OK

{&quot;schemas&quot;:[&quot;urn:ietf:params:scim:api:messages:2.0:ListResponse&quot;],&quot;totalResults&quot;:1,&quot;itemsPerPage&quot;:1,&quot;startIndex&quot;:1,&quot;Resources&quot;:[{&quot;schemas&quot;:[&quot;urn:ietf:params:scim:schemas:core:2.0:User&quot;],&quot;id&quot;:&quot;5fc0c238-1112-11e8-8e45-920c87bdbd75&quot;,&quot;externalId&quot;:&quot;00u1dhhb1fkIGP7RL1d8&quot;,&quot;userName&quot;:&quot;octocat@github.com&quot;,&quot;displayName&quot;:&quot;Mona Octocat&quot;,&quot;name&quot;:{&quot;givenName&quot;:&quot;Mona&quot;,&quot;familyName&quot;:&quot;Octocat&quot;,&quot;formatted&quot;:&quot;Mona Octocat&quot;},&quot;emails&quot;:[{&quot;value&quot;:&quot;octocat@github.com&quot;,&quot;primary&quot;:true}],&quot;active&quot;:true,&quot;meta&quot;:{&quot;resourceType&quot;:&quot;User&quot;,&quot;created&quot;:&quot;2018-02-13T15:05:24.000-08:00&quot;,&quot;lastModified&quot;:&quot;2018-02-13T15:05:55.000-08:00&quot;,&quot;location&quot;:&quot;https://api.github.com/scim/v2/organizations/octo-org/Users/5fc0c238-1112-11e8-8e45-920c87bdbd75&quot;}}]}