Esta versión de GitHub Enterprise Server se discontinuó el 2024-07-09. No se realizarán lanzamientos de patch, ni siquiera para problemas de seguridad críticos. Para obtener rendimiento mejorado, seguridad mejorada y nuevas características, actualice a la versión más reciente de GitHub Enterprise Server. Para obtener ayuda con la actualización, póngase en contacto con el soporte técnico de GitHub Enterprise.
Puntos de conexión de API de REST para SCIM
Usa la API REST para automatizar la creación de usuarios y las pertenencias a equipos con SCIM.
Acerca de SCIM
Nota: SCIM para GitHub Enterprise Server se encuentra actualmente en versión beta privada y está sujeta a cambios. Para acceder a la versión beta, póngase en contacto con el gestor de cuentas en Equipo de ventas de GitHub. Por favor, proporcione comentarios en una discusión de GitHub Community.
Advertencia: La versión beta está pensada exclusivamente para pruebas y comentarios, y no hay soporte técnico disponible. GitHub recomienda realizar pruebas con una instancia de ensayo. Para obtener más información, vea «Configurar una instancia de preparación».
GitHub Enterprise Server proporciona puntos de conexión a fin de que la usen los proveedores de identidades (IDP) habilitados para SCIM. Una integración en el IdP puede usar la API REST a fin de aprovisionar, administrar o desaprovisionar automáticamente cuentas de usuario en una instancia de GitHub Enterprise Server que usa el inicio de sesión único (SSO) de SAML para la autenticación. Para más información sobre el SSO de SAML, consulta "Acerca de SAML para IAM empresarial".
Estos puntos de conexión se basan en SCIM 2.0. Para obtener más información, consulta la documentación de tu IdP o la especificación en el sitio web de IETF.
Direcciones URL raíz
Un IdP puede usar la dirección URL raíz siguiente a fin de comunicarse con los puntos de conexión de esta categoría para una instancia de GitHub Enterprise Server.
http(s)://HOSTNAME/api/v3/scim/v2/
Los puntos de conexión de esta categoría distinguen mayúsculas de minúsculas. Por ejemplo, la primera letra del punto de conexión Users
debe ser mayúscula.
GET /scim/v2/Users/{scim_user_id}
Authentication
La integración de SCIM en el IdP realiza acciones en nombre de un propietario de la empresa para la instancia de GitHub Enterprise Server. Para obtener más información, vea «Roles en una empresa».
Para autenticar las solicitudes en la API, la persona que configura SCIM en el IdP debe usar un personal access token con ámbito admin:enterprise
, que el IdP debe proporcionar en el encabezado Authorization
de la solicitud. Para más información sobre personal access tokens, consulta "Administración de tokens de acceso personal".
Nota: Los propietarios de la empresa deben generar y usar un personal access token para la autenticación de solicitudes a los puntos de conexión de esta categoría. Fine-grained personal access token y En este momento no se admiten los autores de llamadas de aplicaciones de GitHub.
Mapeo de los datos de SAML y de SCIM
La instancia de GitHub Enterprise Server vincula a cada usuario que se autentica correctamente con el inicio de sesión único de SAML en una identidad de SCIM. A fin de vincular correctamente las identidades, el IdP de SAML y la integración de SCIM deben usar los valores NameID
de SAML y userName
de SCIM correspondientes para cada usuario.
Nota: Si GitHub Enterprise Server usa Entra ID como IdP de SAML, GitHub Enterprise Server también comprobará la notificación externalId
de SCIM y http://schemas.microsoft.com/identity/claims/objectidentifier
de SAML para que coincidan primero con los usuarios, en lugar de usar NameID
y userName
.
Atributos de usuario de SCIM compatibles
Los puntos de conexión User
de esta categoría admiten los atributos siguientes en los parámetros de una solicitud.
Nombre | Escribir | Description |
---|---|---|
displayName | String | Nombre legible para el usuario. |
name.formatted | String | El nombre completo del usuario, incluido el segundo nombre, los títulos y los sufijos, con formato para mostrar. |
name.givenName | String | El nombre del usuario. |
name.familyName | String | Los apellidos del usuario. |
userName | String | Nombre de usuario del usuario, que genera el IdP. Se somete a la normalización antes de su uso. |
emails | Array | Lista de correos electrónicos del usuario. |
roles | Array | Lista de roles del usuario. |
externalId | String | Este identificador lo genera un proveedor de IdP. Puedes encontrar el elemento externalId de un usuario en el idP, o mediante el punto de conexión Enumerar las identidades aprovisionadas de SCIM y filtrando por otros atributos conocidos, como el nombre de usuario o la dirección de correo electrónico del usuario en la instancia de GitHub Enterprise Server. |
id | String | Identificador que genera el punto de conexión de SCIM de la instancia. |
active | Boolean | Indica si la identidad está activa (true ) o debe suspenderse (false ). |
List provisioned SCIM groups for an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
Lists provisioned SCIM groups in an enterprise.
You can improve query search time by using the excludedAttributes
query parameter with a value of members
to exclude members from the response.
Parámetros para "List provisioned SCIM groups for an enterprise"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nombre, Tipo, Descripción |
---|
filter string If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are |
excludedAttributes string Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. |
startIndex integer Used for pagination: the starting index of the first result to return when paginating through values. Valor predeterminado: |
count integer Used for pagination: the number of results to return per page. Valor predeterminado: |
Códigos de estado de respuesta HTTP para "List provisioned SCIM groups for an enterprise"
status code | Descripción |
---|---|
200 | Success, either groups were found or not found |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "List provisioned SCIM groups for an enterprise"
Ejemplo de solicitud
curl -L \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Groups
Success, either groups were found or not found
Status: 200
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 1,
"Resources": [
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
"id": "927fa2c08dcb4a7fae9e",
"displayName": "Engineering",
"members": [
{
"value": "879db59-3bdf-4490-ad68-ab880a2694745",
"$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745",
"displayName": "User 1"
},
{
"value": "0db508eb-91e2-46e4-809c-30dcbda0c685",
"$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685",
"displayName": "User 2"
}
],
"meta": {
"resourceType": "Group",
"created": "2012-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z",
"location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e"
}
}
],
"startIndex": 1,
"itemsPerPage": 20
}
Provision a SCIM enterprise group
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
Creates a SCIM group for an enterprise.
If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the externalId
and id
of each user.
Parámetros para "Provision a SCIM enterprise group"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nombre, Tipo, Descripción | |||
---|---|---|---|
schemas array of strings RequeridoThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||
externalId string RequeridoA unique identifier for the resource as defined by the provisioning client. | |||
displayName string RequeridoA human-readable name for a security group. | |||
members array of objects RequeridoThe group members. | |||
Properties of |
Nombre, Tipo, Descripción |
---|
value string RequeridoThe local unique identifier for the member |
displayName string RequeridoThe display name associated with the member |
Códigos de estado de respuesta HTTP para "Provision a SCIM enterprise group"
status code | Descripción |
---|---|
201 | Group has been created |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
409 | Duplicate record detected |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "Provision a SCIM enterprise group"
Ejemplo de solicitud
curl -L \
-X POST \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Groups \
-d '{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"externalId":"8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159","displayName":"Engineering"}'
Group has been created
Status: 201
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc",
"externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
"displayName": "Engineering",
"members": [
{
"value": "879db59-3bdf-4490-ad68-ab880a2694745",
"$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745",
"displayName": "User 1"
},
{
"value": "0db508eb-91e2-46e4-809c-30dcbda0c685",
"$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685",
"displayName": "User 2"
}
],
"meta": {
"resourceType": "Group",
"created": "2012-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z",
"location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e"
}
}
Get SCIM provisioning information for an enterprise group
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
Gets information about a SCIM group.
Parámetros para "Get SCIM provisioning information for an enterprise group"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
scim_group_id string RequeridoA unique identifier of the SCIM group. |
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nombre, Tipo, Descripción |
---|
excludedAttributes string Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. |
Códigos de estado de respuesta HTTP para "Get SCIM provisioning information for an enterprise group"
status code | Descripción |
---|---|
200 | Success, a group was found |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
404 | Resource not found |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "Get SCIM provisioning information for an enterprise group"
Ejemplo de solicitud
curl -L \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID
Success, a group was found
Status: 200
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc",
"externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
"displayName": "Engineering",
"members": [
{
"value": "879db59-3bdf-4490-ad68-ab880a2694745",
"$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745",
"displayName": "User 1"
},
{
"value": "0db508eb-91e2-46e4-809c-30dcbda0c685",
"$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685",
"displayName": "User 2"
}
],
"meta": {
"resourceType": "Group",
"created": "2012-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z",
"location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e"
}
}
Set SCIM information for a provisioned enterprise group
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
Replaces an existing provisioned group’s information.
You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
Parámetros para "Set SCIM information for a provisioned enterprise group"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
scim_group_id string RequeridoA unique identifier of the SCIM group. |
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nombre, Tipo, Descripción | |||
---|---|---|---|
schemas array of strings RequeridoThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||
externalId string RequeridoA unique identifier for the resource as defined by the provisioning client. | |||
displayName string RequeridoA human-readable name for a security group. | |||
members array of objects RequeridoThe group members. | |||
Properties of |
Nombre, Tipo, Descripción |
---|
value string RequeridoThe local unique identifier for the member |
displayName string RequeridoThe display name associated with the member |
Códigos de estado de respuesta HTTP para "Set SCIM information for a provisioned enterprise group"
status code | Descripción |
---|---|
200 | Group was updated |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
404 | Resource not found |
409 | Duplicate record detected |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "Set SCIM information for a provisioned enterprise group"
Ejemplos de solicitud
curl -L \
-X PUT \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \
-d '{"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"],"externalId":"8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159","displayName":"Engineering"}'
Group was updated
Status: 200
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc",
"externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
"displayName": "Engineering",
"members": [
{
"value": "879db59-3bdf-4490-ad68-ab880a2694745",
"$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745",
"displayName": "User 1"
},
{
"value": "0db508eb-91e2-46e4-809c-30dcbda0c685",
"$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685",
"displayName": "User 2"
}
],
"meta": {
"resourceType": "Group",
"created": "2012-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z",
"location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e"
}
}
Update an attribute for a SCIM enterprise group
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
Update a provisioned group’s individual attributes.
To change a group’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. Update can also be used to add group memberships.
Group memberships can be sent one at a time or in batches for faster performance. Note: The memberships are referenced through a local user id
, and the user will need to be created before they are referenced here.
Parámetros para "Update an attribute for a SCIM enterprise group"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
scim_group_id string RequeridoA unique identifier of the SCIM group. |
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nombre, Tipo, Descripción | ||||
---|---|---|---|---|
Operations array of objects Requeridopatch operations list | ||||
Properties of |
Nombre, Tipo, Descripción |
---|
op string RequeridoPuede ser uno de los siguientes: |
path string |
value string Corresponding 'value' of that field specified by 'path' |
schemas
array of strings RequeridoundefinedSupported values are: urn:ietf:params:scim:api:messages:2.0:PatchOp
Códigos de estado de respuesta HTTP para "Update an attribute for a SCIM enterprise group"
status code | Descripción |
---|---|
200 | Success, group was updated |
204 | No Content |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
404 | Resource not found |
409 | Duplicate record detected |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "Update an attribute for a SCIM enterprise group"
Ejemplos de solicitud
curl -L \
-X PATCH \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \
-d '{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"displayName","value":"Employees"}]}'
Success, group was updated
Status: 200
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc",
"externalId": "8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159",
"displayName": "Engineering",
"members": [
{
"value": "879db59-3bdf-4490-ad68-ab880a2694745",
"$+ref": "https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745",
"displayName": "User 1"
},
{
"value": "0db508eb-91e2-46e4-809c-30dcbda0c685",
"$+ref": "https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685",
"displayName": "User 2"
}
],
"meta": {
"resourceType": "Group",
"created": "2012-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z",
"location": "https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e"
}
}
Delete a SCIM group from an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
Deletes a SCIM group from an enterprise.
Parámetros para "Delete a SCIM group from an enterprise"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
scim_group_id string RequeridoA unique identifier of the SCIM group. |
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Códigos de estado de respuesta HTTP para "Delete a SCIM group from an enterprise"
status code | Descripción |
---|---|
204 | Group was deleted, no content |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
404 | Resource not found |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "Delete a SCIM group from an enterprise"
Ejemplo de solicitud
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID
Group was deleted, no content
Status: 204
List SCIM provisioned identities for an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
Lists provisioned SCIM enterprise members.
When a user with a SCIM-provisioned external identity is removed from an enterprise through a patch
with active
flag set to false
, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the delete
request. Users that were not permanently deleted will be visible in the returned results.
Parámetros para "List SCIM provisioned identities for an enterprise"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nombre, Tipo, Descripción |
---|
filter string If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are |
startIndex integer Used for pagination: the starting index of the first result to return when paginating through values. Valor predeterminado: |
count integer Used for pagination: the number of results to return per page. Valor predeterminado: |
Códigos de estado de respuesta HTTP para "List SCIM provisioned identities for an enterprise"
status code | Descripción |
---|---|
200 | Success, either users were found or not found |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "List SCIM provisioned identities for an enterprise"
Ejemplo de solicitud
curl -L \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Users
Success, either users were found or not found
Status: 200
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 1,
"Resources": [
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"externalId": "E012345",
"id": "7fce0092-d52e-4f76-b727-3955bd72c939",
"active": true,
"userName": "E012345",
"name": {
"formatted": "Ms. Mona Lisa Octocat",
"familyName": "Octocat",
"givenName": "Mona",
"middleName": "Lisa"
},
"displayName": "Mona Lisa",
"emails": [
{
"value": "mlisa@example.com",
"type": "work",
"primary": true
}
],
"roles": [
{
"value": "User",
"primary": false
}
]
}
],
"startIndex": 1,
"itemsPerPage": 20
}
Provision a SCIM enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
Creates an external identity for a new SCIM enterprise user.
SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response NameID
to SCIM userName
.
When converting existing enterprise to use SCIM, the user handle (userName
) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.
Parámetros para "Provision a SCIM enterprise user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
schemas array of strings RequeridoThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||||
externalId string RequeridoA unique identifier for the resource as defined by the provisioning client. | |||||
active boolean RequeridoWhether the user active in the IdP. | |||||
userName string RequeridoThe username for the user. | |||||
name object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
formatted string The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. |
familyName string RequeridoThe family name of the user. |
givenName string RequeridoThe given name of the user. |
middleName string The middle name(s) of the user. |
displayName
string RequeridoA human-readable name for the user.
emails
array of objects RequeridoThe emails for the user.
Properties of emails
Nombre, Tipo, Descripción |
---|
value string RequeridoThe email address. |
type string RequeridoThe type of email address. |
primary boolean RequeridoWhether this email address is the primary address. |
roles
array of objects The roles assigned to the user.
Properties of roles
Nombre, Tipo, Descripción |
---|
display string |
type string |
value string RequeridoThe role value representing a user role in GitHub. Puede ser uno de los siguientes: |
primary boolean Is the role a primary role for the user. |
Códigos de estado de respuesta HTTP para "Provision a SCIM enterprise user"
status code | Descripción |
---|---|
201 | User has been created |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
409 | Duplicate record detected |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "Provision a SCIM enterprise user"
Ejemplos de solicitud
curl -L \
-X POST \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Users \
-d '{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"externalId":"E012345","active":true,"userName":"E012345","name":{"formatted":"Ms. Mona Lisa Octocat","familyName":"Octocat","givenName":"Mona","middleName":"Lisa"},"displayName":"Mona Lisa","emails":[{"value":"mlisa@example.com","type":"work","primary":true}],"roles":[{"value":"User","primary":false}]}'
User has been created
Status: 201
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"id": "7fce0092-d52e-4f76-b727-3955bd72c939",
"externalId": "E012345",
"active": true,
"userName": "E012345",
"name": {
"formatted": "Ms. Mona Lisa Octocat",
"familyName": "Octocat",
"givenName": "Mona",
"middleName": "Lisa"
},
"displayName": "Mona Lisa",
"emails": [
{
"value": "mlisa@example.com",
"type": "work",
"primary": true
}
],
"roles": [
{
"value": "User",
"primary": false
}
],
"meta": {
"resourceType": "User",
"created": "2012-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z",
"location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939"
}
}
Get SCIM provisioning information for an enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
Gets information about a SCIM user.
Parámetros para "Get SCIM provisioning information for an enterprise user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
scim_user_id string RequeridoThe unique identifier of the SCIM user. |
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Códigos de estado de respuesta HTTP para "Get SCIM provisioning information for an enterprise user"
status code | Descripción |
---|---|
200 | Success, a user was found |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
404 | Resource not found |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "Get SCIM provisioning information for an enterprise user"
Ejemplo de solicitud
curl -L \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Users/SCIM_USER_ID
Success, a user was found
Status: 200
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"id": "7fce0092-d52e-4f76-b727-3955bd72c939",
"externalId": "E012345",
"active": true,
"userName": "E012345",
"name": {
"formatted": "Ms. Mona Lisa Octocat",
"familyName": "Octocat",
"givenName": "Mona",
"middleName": "Lisa"
},
"displayName": "Mona Lisa",
"emails": [
{
"value": "mlisa@example.com",
"type": "work",
"primary": true
}
],
"roles": [
{
"value": "User",
"primary": false
}
],
"meta": {
"resourceType": "User",
"created": "2012-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z",
"location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939"
}
}
Set SCIM information for a provisioned enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
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.
Warning: Setting active: false
will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
Parámetros para "Set SCIM information for a provisioned enterprise user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
scim_user_id string RequeridoThe unique identifier of the SCIM user. |
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nombre, Tipo, Descripción | |||||
---|---|---|---|---|---|
schemas array of strings RequeridoThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||||
externalId string RequeridoA unique identifier for the resource as defined by the provisioning client. | |||||
active boolean RequeridoWhether the user active in the IdP. | |||||
userName string RequeridoThe username for the user. | |||||
name object | |||||
Properties of |
Nombre, Tipo, Descripción |
---|
formatted string The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. |
familyName string RequeridoThe family name of the user. |
givenName string RequeridoThe given name of the user. |
middleName string The middle name(s) of the user. |
displayName
string RequeridoA human-readable name for the user.
emails
array of objects RequeridoThe emails for the user.
Properties of emails
Nombre, Tipo, Descripción |
---|
value string RequeridoThe email address. |
type string RequeridoThe type of email address. |
primary boolean RequeridoWhether this email address is the primary address. |
roles
array of objects The roles assigned to the user.
Properties of roles
Nombre, Tipo, Descripción |
---|
display string |
type string |
value string RequeridoThe role value representing a user role in GitHub. Puede ser uno de los siguientes: |
primary boolean Is the role a primary role for the user. |
Códigos de estado de respuesta HTTP para "Set SCIM information for a provisioned enterprise user"
status code | Descripción |
---|---|
200 | User was updated |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
404 | Resource not found |
409 | Duplicate record detected |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "Set SCIM information for a provisioned enterprise user"
Ejemplo de solicitud
curl -L \
-X PUT \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Users/SCIM_USER_ID \
-d '{"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"externalId":"E012345","active":true,"userName":"E012345","name":{"formatted":"Ms. Mona Lisa Octocat","familyName":"Octocat","givenName":"Mona","middleName":"Lisa"},"displayName":"Mona Lisa","emails":[{"value":"mlisa@example.com","type":"work","primary":true}],"roles":[{"value":"User","primary":false}]}'
User was updated
Status: 200
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"id": "7fce0092-d52e-4f76-b727-3955bd72c939",
"externalId": "E012345",
"active": true,
"userName": "E012345",
"name": {
"formatted": "Ms. Mona Lisa Octocat",
"familyName": "Octocat",
"givenName": "Mona",
"middleName": "Lisa"
},
"displayName": "Mona Lisa",
"emails": [
{
"value": "mlisa@example.com",
"type": "work",
"primary": true
}
],
"roles": [
{
"value": "User",
"primary": false
}
],
"meta": {
"resourceType": "User",
"created": "2012-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z",
"location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939"
}
}
Update an attribute for a SCIM enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
Update 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: Setting active: false
will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.
{
"Operations":[{
"op":"replace",
"value":{
"active":false
}
}]
}
Parámetros para "Update an attribute for a SCIM enterprise user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
scim_user_id string RequeridoThe unique identifier of the SCIM user. |
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nombre, Tipo, Descripción | ||||
---|---|---|---|---|
Operations array of objects Requeridopatch operations list | ||||
Properties of |
Nombre, Tipo, Descripción |
---|
op string RequeridoPuede ser uno de los siguientes: |
path string |
value string Corresponding 'value' of that field specified by 'path' |
schemas
array of strings RequeridoundefinedSupported values are: urn:ietf:params:scim:api:messages:2.0:PatchOp
Códigos de estado de respuesta HTTP para "Update an attribute for a SCIM enterprise user"
status code | Descripción |
---|---|
200 | Success, user was updated |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
404 | Resource not found |
409 | Duplicate record detected |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "Update an attribute for a SCIM enterprise user"
Ejemplos de solicitud
curl -L \
-X PATCH \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Users/SCIM_USER_ID \
-d '{"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],"Operations":[{"op":"replace","path":"emails[type eq '\''work'\''].value","value":"updatedEmail@microsoft.com"},{"op":"replace","path":"name.familyName","value":"updatedFamilyName"}]}'
Success, user was updated
Status: 200
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"id": "7fce0092-d52e-4f76-b727-3955bd72c939",
"externalId": "E012345",
"active": true,
"userName": "E012345",
"name": {
"formatted": "Ms. Mona Lisa Octocat",
"familyName": "Octocat",
"givenName": "Mona",
"middleName": "Lisa"
},
"displayName": "Mona Lisa",
"emails": [
{
"value": "mlisa@example.com",
"type": "work",
"primary": true
}
],
"roles": [
{
"value": "User",
"primary": false
}
],
"meta": {
"resourceType": "User",
"created": "2012-03-27T19:59:26.000Z",
"lastModified": "2018-03-27T19:59:26.000Z",
"location": "https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939"
}
}
Delete a SCIM user from an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.
Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.
Parámetros para "Delete a SCIM user from an enterprise"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
scim_user_id string RequeridoThe unique identifier of the SCIM user. |
enterprise string RequeridoThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Códigos de estado de respuesta HTTP para "Delete a SCIM user from an enterprise"
status code | Descripción |
---|---|
204 | User was deleted, no content |
400 | Bad request |
401 | Authorization failure |
403 | Permission denied |
404 | Resource not found |
429 | Too many requests |
500 | Internal server error |
Ejemplos de código para "Delete a SCIM user from an enterprise"
Ejemplo de solicitud
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Users/SCIM_USER_ID
User was deleted, no content
Status: 204