saml_identities

Creates, updates, deletes, gets or lists a saml_identities resource.

Overview

Name	saml_identities
Type	Resource
Id	github.orgs.saml_identities

Fields

The following fields are returned by SELECT queries:

list

Response

Name	Datatype	Description
id	string	The GraphQL node ID of the external identity.
guid	string	The GUID for this identity.
saml_identity	object	The SAML identity (name_id, username, emails[]).
scim_identity	object	The SCIM identity (username, emails[]).
user	object	The linked GitHub user, null for unlinked identities (login, id).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	org		External identities (SAML and SCIM) linked to organization members when the organization uses SAML single sign-on. Backed by the GitHub GraphQL API (organization.samlIdentityProvider.externalIdentities). Requires organization owner access and an organization with SAML SSO configured.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
org	string	The organization name.

SELECT examples

list

External identities (SAML and SCIM) linked to organization members when the organization uses SAML single sign-on. Backed by the GitHub GraphQL API (organization.samlIdentityProvider.externalIdentities). Requires organization owner access and an organization with SAML SSO configured.

SELECT
id,
guid,
saml_identity,
scim_identity,
user
FROM github.orgs.saml_identities
WHERE org = '{{ org }}' -- required
;