Aprovisionamiento de SCIM para las Organizaciones
Los proveedores de identidad (IdP) habilitados para SCIM utilizan la API de SCIM para automatizar el aprovisionamiento de la membrecía de las organizaciones de GitHub. La API de GitHub se basa en la versión 2.0 del estándar de SCIM. La terminal de SCIM de GitHub que deben utilizar los IdP es: https://api.github.com/scim/v2/organizations/{org}/
.
Nota: La API de SCIM está disponible solo para las organizaciones en GitHub Enterprise Cloud que tienen habilitado el SSO de SAML. Para obtener más información acerca de SCIM, consulta "Acerca de SCIM".
Autenticar las llamadas a la API de SCIM
Debes autenticarte como un propietario de una organización de GitHub para utilizar la API de SCIM. La API espera que se incluya un token Portador de OAuth 2.0 en el encabezado Authorization
. También puedes utilizar un token de acceso personal, pero primero debes autorizarlo para su uso con tu orgnización que cuenta con el SSO de SAML.
Mapeo de los datos de SAML y de SCIM
El IdP de SAML y el cliente de SCIM deben utilizar valores coincidentes de NameID
y userName
para cada usuario. Esto le permite al usuario que se autentica mediante SAML el poder enlazarse con su identidad aprovisionada de SCIM.
Atributos de Usuario de SCIM compatibles
Nombre | Tipo | Descripción |
---|---|---|
userName | secuencia | El nombre de usuario para el usuario. |
name.givenName | secuencia | El primer nombre del usuario. |
name.lastName | secuencia | El apellido del usuario. |
correos electrónicos | array | Lista de correos electrónicos del usuario. |
externalId | secuencia | El proveedor de SAML genera este identificador, el cual utiliza como una ID única para empatarla contra un usuario de GitHub. Puedes encontrar la externalID de un usuario ya sea con el proveedor de SAML, o utilizando la terminal de Listar las identidades aprovisionadas de SCIM y filtrando otros atributos conocidos, tales como el nombre de usuario de GitHub o la dirección de correo electrónico de un usuario. |
id | secuencia | Identificador que genera la terminal de SCIM de GitHub. |
active | boolean | Se utiliza para indicar si la identidad está activa (true) o si debe desaprovisionarse (false). |
Nota: Las URL de terminal para la API de SCIM distinguen entre mayúsculas y minúsculas. Por ejemplo, la primera letra en la terminal Users
debe ponerse en mayúscula:
GET /scim/v2/organizations/{org}/Users/{scim_user_id}
List SCIM provisioned identities
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:
-
The user is granted access by the IdP and is not a member of the GitHub organization.
-
The user attempts to access the GitHub organization and initiates the SAML SSO process, and is not currently signed in to their GitHub account.
-
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.
get /scim/v2/organizations/{org}/Users
Parámetros
Name | Type | In | Description |
---|---|---|---|
accept |
string | header |
Setting to |
org |
string | path | |
startIndex |
integer | query | Used for pagination: the index of the first result to return. |
count |
integer | query | Used for pagination: the number of results to return. |
filter |
string | query | Filters results using the equals query parameter operator (
To filter results for the identity with the email
|
Ejemplos de código
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/scim/v2/organizations/ORG/Users
JavaScript (@octokit/core.js)
await octokit.request('GET /scim/v2/organizations/{org}/Users', {
org: 'org'
})
Response
Status: 200 OK
Not modified
Status: 304 Not Modified
Bad request
Status: 400 Bad Request
Forbidden
Status: 403 Forbidden
Resource not found
Status: 404 Not Found
Notes
Provision and invite a SCIM user
Provision organization membership for a user, and send an activation email to the email address.
post /scim/v2/organizations/{org}/Users
Parámetros
Name | Type | In | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
accept |
string | header |
Setting to |
||||||
org |
string | path | |||||||
userName |
string | body |
Required. Configured by the admin. Could be an email, login, or username |
||||||
displayName |
string | body |
The name of the user, suitable for display to end-users |
||||||
name |
object | body |
Required. undefined |
||||||
name object |
givenName (string) |
Required. undefined |
familyName (string) |
Required. undefined |
formatted (string) |
undefined |
emails
Required. user emails
Properties of the emails
items
emails
itemsvalue (string) |
Required. undefined |
primary (boolean) |
undefined |
type (string) |
undefined |
schemas
undefined
externalId
undefined
groups
undefined
active
undefined
Ejemplos de código
Shell
curl \
-X POST \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/scim/v2/organizations/ORG/Users \
-d '{"userName":"userName","name":{"givenName":"givenName","familyName":"familyName","formatted":"formatted"},"emails":["octocat@github.com"]}'
JavaScript (@octokit/core.js)
await octokit.request('POST /scim/v2/organizations/{org}/Users', {
org: 'org',
userName: 'userName',
name: {
givenName: 'givenName',
familyName: 'familyName',
formatted: 'formatted'
},
emails: [
'octocat@github.com'
]
})
Response
Status: 201 Created
Not modified
Status: 304 Not Modified
Bad request
Status: 400 Bad Request
Forbidden
Status: 403 Forbidden
Resource not found
Status: 404 Not Found
Conflict
Status: 409 Conflict
Internal error
Status: 500 Internal Server Error
Notes
get /scim/v2/organizations/{org}/Users/{scim_user_id}
Parámetros
Name | Type | In | Description |
---|---|---|---|
accept |
string | header |
Setting to |
org |
string | path | |
scim_user_id |
string | path | scim_user_id parameter |
Ejemplos de código
Shell
curl \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/scim/v2/organizations/ORG/Users/SCIM_USER_ID
JavaScript (@octokit/core.js)
await octokit.request('GET /scim/v2/organizations/{org}/Users/{scim_user_id}', {
org: 'org',
scim_user_id: 'scim_user_id'
})
Response
Status: 200 OK
Not modified
Status: 304 Not Modified
Forbidden
Status: 403 Forbidden
Resource not found
Status: 404 Not Found
Notes
Update a provisioned organization membership
Replaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
You must at least provide the required values for the user: userName
, name
, and emails
.
Warning: Setting active: false
removes the user from the organization, deletes the external identity, and deletes the associated {scim_user_id}
.
put /scim/v2/organizations/{org}/Users/{scim_user_id}
Parámetros
Name | Type | In | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
accept |
string | header |
Setting to |
||||||
org |
string | path | |||||||
scim_user_id |
string | path | scim_user_id parameter |
||||||
schemas |
array of strings | body |
undefined |
||||||
displayName |
string | body |
The name of the user, suitable for display to end-users |
||||||
externalId |
string | body |
undefined |
||||||
groups |
array of strings | body |
undefined |
||||||
active |
boolean | body |
undefined |
||||||
userName |
string | body |
Required. Configured by the admin. Could be an email, login, or username |
||||||
name |
object | body |
Required. undefined |
||||||
name object |
givenName (string) |
Required. undefined |
familyName (string) |
Required. undefined |
formatted (string) |
undefined |
emails
Required. user emails
Properties of the emails
items
emails
itemstype (string) |
undefined |
value (string) |
Required. undefined |
primary (boolean) |
undefined |
Ejemplos de código
Shell
curl \
-X PUT \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/scim/v2/organizations/ORG/Users/SCIM_USER_ID \
-d '{"userName":"userName","name":{"givenName":"givenName","familyName":"familyName","formatted":"formatted"},"emails":["octocat@github.com"]}'
JavaScript (@octokit/core.js)
await octokit.request('PUT /scim/v2/organizations/{org}/Users/{scim_user_id}', {
org: 'org',
scim_user_id: 'scim_user_id',
userName: 'userName',
name: {
givenName: 'givenName',
familyName: 'familyName',
formatted: 'formatted'
},
emails: [
'octocat@github.com'
]
})
Response
Status: 200 OK
Not modified
Status: 304 Not Modified
Forbidden
Status: 403 Forbidden
Resource not found
Status: 404 Not Found
Notes
Update an attribute for a SCIM user
Allows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific Operations
JSON format that contains at least one of the add
, remove
, or replace
operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note: Complicated SCIM path
selectors that include filters are not supported. For example, a path
selector defined as "path": "emails[type eq \"work\"]"
will not work.
Warning: If you set active:false
using the replace
operation (as shown in the JSON example below), it removes the user from the organization, deletes the external identity, and deletes the associated :scim_user_id
.
{
"Operations":[{
"op":"replace",
"value":{
"active":false
}
}]
}
patch /scim/v2/organizations/{org}/Users/{scim_user_id}
Parámetros
Name | Type | In | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
accept |
string | header |
Setting to |
||||||
org |
string | path | |||||||
scim_user_id |
string | path | scim_user_id parameter |
||||||
schemas |
array of strings | body |
undefined |
||||||
Operations |
array of objects | body |
Required. Set of operations to be performed |
||||||
Operations items |
op (string) |
Required. undefined |
path (string) |
undefined |
value () |
undefined |
Ejemplos de código
Shell
curl \
-X PATCH \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/scim/v2/organizations/ORG/Users/SCIM_USER_ID \
-d '{"Operations":[{"op":"op","path":"path","value":{"active":true,"userName":"userName","externalId":"externalId","givenName":"givenName","familyName":"familyName"}}]}'
JavaScript (@octokit/core.js)
await octokit.request('PATCH /scim/v2/organizations/{org}/Users/{scim_user_id}', {
org: 'org',
scim_user_id: 'scim_user_id',
Operations: [
{
op: 'op',
path: 'path',
value: {
active: true,
userName: 'userName',
externalId: 'externalId',
givenName: 'givenName',
familyName: 'familyName'
}
}
]
})
Response
Status: 200 OK
Not modified
Status: 304 Not Modified
Bad request
Status: 400 Bad Request
Forbidden
Status: 403 Forbidden
Resource not found
Status: 404 Not Found
Too many requests
Status: 429 Too Many Requests
Notes
delete /scim/v2/organizations/{org}/Users/{scim_user_id}
Parámetros
Name | Type | In | Description |
---|---|---|---|
accept |
string | header |
Setting to |
org |
string | path | |
scim_user_id |
string | path | scim_user_id parameter |
Ejemplos de código
Shell
curl \
-X DELETE \
-H "Accept: application/vnd.github.v3+json" \
https://api.github.com/scim/v2/organizations/ORG/Users/SCIM_USER_ID
JavaScript (@octokit/core.js)
await octokit.request('DELETE /scim/v2/organizations/{org}/Users/{scim_user_id}', {
org: 'org',
scim_user_id: 'scim_user_id'
})
Default Response
Status: 204 No Content
Not modified
Status: 304 Not Modified
Forbidden
Status: 403 Forbidden
Resource not found
Status: 404 Not Found