Cette version de GitHub Enterprise Server n'est plus disponible depuis le 2024-03-26. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.
Points de terminaison d’API REST pour SCIM
Utilisez l’API REST pour automatiser la création d’utilisateurs et les appartenances aux équipes avec SCIM.
À propos de SCIM
Remarque : SCIM pour GitHub Enterprise Server est en version bêta privée et est susceptible de changer. Pour accéder à la bêta, contactez votre responsable de compte dans l’L’équipe commerciale GitHub. Merci de nous faire part de vos commentaires dans la discussion GitHub Community.
Avertissement : La bêta est exclusivement destinée aux tests et aux commentaires. Aucun support n’est disponible. GitHub recommande d’effectuer les tests avec une instance de préproduction. Pour plus d’informations, consultez « Configuration d’une instance de préproduction ».
GitHub Enterprise Server fournit des points de terminaison destinés aux fournisseurs d’identité (IdP) prenant en charge SCIM. Une intégration sur l’IdP peut utiliser l’API REST pour provisionner, gérer ou déprovisionner automatiquement des comptes d’utilisateur sur une instance GitHub Enterprise Server qui utilise l’authentification unique (SSO) SAML pour l’authentification. Pour plus d’informations sur SSO SAML, consultez « À propos de SAML pour la gestion des identités et des accès d'entreprise ».
Ces points de terminaison sont basés sur SCIM 2.0. Pour plus d’informations, consultez la documentation de votre fournisseur d’identité ou consultez les spécifications sur le site web IETF.
URL racine
Un fournisseur d’identité peut utiliser l’URL racine suivante afin de communiquer avec les points de terminaison pour une instance GitHub Enterprise Server.
http(s)://HOSTNAME/api/v3/scim/v2/
Les points de terminaison de cette catégorie respectent la casse. Par exemple, la première lettre du point de terminaison Users
doit être en majuscule.
GET /scim/v2/Users/{scim_user_id}
Authentification
L’intégration SCIM sur l’idP effectue des actions pour le compte d’un propriétaire d’entreprise pour l’instance GitHub Enterprise Server. Pour plus d’informations, consultez « Rôles dans une entreprise ».
Pour authentifier les demandes adressées à l’API, la personne qui configure SCIM sur l’IdP doit utiliser un personal access token avec l’étendue admin:enterprise
, que l’IdP doit fournir dans l’en-tête Authorization
de la demande. Pour plus d’informations sur les personal access tokens, consultez « Gestion de vos jetons d'accès personnels ».
Remarque : Les propriétaires d’entreprise doivent générer et utiliser un personal access token pour l’authentification des demandes adressées aux points de terminaison. Les appelants d’application GitHub ne sont pas pris en charge.
Mappage des données SAML et SCIM
L’instance GitHub Enterprise Server lie chaque utilisateur qui s’authentifie avec succès avec l’authentification unique SAML à une identité SCIM. Pour lier correctement les identités, le fournisseur d’identité SAML et l’intégration SCIM doivent utiliser des valeurs SAML NameID
et SCIM userName
correspondantes pour chaque utilisateur.
Remarque : Si GitHub Enterprise Server utilise Entra ID comme fournisseur d’identité SAML, GitHub Enterprise Server vérifie également la revendication SCIM externalId
et la revendication SAML http://schemas.microsoft.com/identity/claims/objectidentifier
pour établir une correspondance avec les utilisateurs en premier, au lieu d’utiliser NameID
et userName
.
Attributs utilisateur SCIM pris en charge
Les points de terminaison User
dans cette catégorie prennent en charge les attributs suivants dans les paramètres d’une demande.
Nom | Type | Description |
---|---|---|
displayName | String | Nom lisible pour un utilisateur. |
name.formatted | String | Nom complet de l’utilisateur, y compris tous les prénoms, titres et suffixes, mis en forme pour l’affichage. |
name.givenName | String | Prénom de l’utilisateur. |
name.familyName | String | Nom de l’utilisateur. |
userName | String | Nom d’utilisateur de l’utilisateur, généré par le fournisseur d’identité. Subit la normalisation avant d’être utilisé. |
emails | Array | Liste des e-mails de l’utilisateur. |
roles | Array | Liste des rôles de l’utilisateur. |
externalId | String | Cet identificateur est généré par un fournisseur d’identité. Vous pouvez trouver l’externalId pour un utilisateur sur l’IdP ou en utilisant le point de terminaison Lister les identités provisionnées SCIM et en filtrant sur d’autres attributs connus, tels que le nom d’utilisateur ou l’adresse e-mail d’un utilisateur sur l’instance GitHub Enterprise Server. |
id | String | Identificateur généré par le point de terminaison SCIM de l’instance. |
active | Boolean | Indique si l’identité est active (true ) ou doit être suspendue (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.
Paramètres pour « List provisioned SCIM groups for an enterprise »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nom, Type, Description |
---|
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. Default: |
count integer Used for pagination: the number of results to return per page. Default: |
Codes d’état de la réponse HTTP pour « List provisioned SCIM groups for an enterprise »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « List provisioned SCIM groups for an enterprise »
Exemple de requête
curl -L \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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.
Paramètres pour « Provision a SCIM enterprise group »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nom, Type, Description | |||
---|---|---|---|
schemas array of strings ObligatoireThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||
externalId string ObligatoireA unique identifier for the resource as defined by the provisioning client. | |||
displayName string ObligatoireA human-readable name for a security group. | |||
members array of objects ObligatoireThe group members. | |||
Properties of |
Nom, Type, Description |
---|
value string ObligatoireThe local unique identifier for the member |
displayName string ObligatoireThe display name associated with the member |
Codes d’état de la réponse HTTP pour « Provision a SCIM enterprise group »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « Provision a SCIM enterprise group »
Exemple de requête
curl -L \
-X POST \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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.
Paramètres pour « Get SCIM provisioning information for an enterprise group »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
scim_group_id string ObligatoireA unique identifier of the SCIM group. |
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nom, Type, Description |
---|
excludedAttributes string Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. |
Codes d’état de la réponse HTTP pour « Get SCIM provisioning information for an enterprise group »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « Get SCIM provisioning information for an enterprise group »
Exemple de requête
curl -L \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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.
Paramètres pour « Set SCIM information for a provisioned enterprise group »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
scim_group_id string ObligatoireA unique identifier of the SCIM group. |
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nom, Type, Description | |||
---|---|---|---|
schemas array of strings ObligatoireThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||
externalId string ObligatoireA unique identifier for the resource as defined by the provisioning client. | |||
displayName string ObligatoireA human-readable name for a security group. | |||
members array of objects ObligatoireThe group members. | |||
Properties of |
Nom, Type, Description |
---|
value string ObligatoireThe local unique identifier for the member |
displayName string ObligatoireThe display name associated with the member |
Codes d’état de la réponse HTTP pour « Set SCIM information for a provisioned enterprise group »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « Set SCIM information for a provisioned enterprise group »
Exemples de requête
curl -L \
-X PUT \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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.
Paramètres pour « Update an attribute for a SCIM enterprise group »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
scim_group_id string ObligatoireA unique identifier of the SCIM group. |
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nom, Type, Description | ||||
---|---|---|---|---|
Operations array of objects Obligatoirepatch operations list | ||||
Properties of |
Nom, Type, Description |
---|
op string ObligatoirePeut être: |
path string |
value string Corresponding 'value' of that field specified by 'path' |
schemas
array of strings ObligatoireundefinedSupported values are: urn:ietf:params:scim:api:messages:2.0:PatchOp
Codes d’état de la réponse HTTP pour « Update an attribute for a SCIM enterprise group »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « Update an attribute for a SCIM enterprise group »
Exemples de requête
curl -L \
-X PATCH \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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.
Paramètres pour « Delete a SCIM group from an enterprise »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
scim_group_id string ObligatoireA unique identifier of the SCIM group. |
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Codes d’état de la réponse HTTP pour « Delete a SCIM group from an enterprise »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « Delete a SCIM group from an enterprise »
Exemple de requête
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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.
Paramètres pour « List SCIM provisioned identities for an enterprise »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nom, Type, Description |
---|
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. Default: |
count integer Used for pagination: the number of results to return per page. Default: |
Codes d’état de la réponse HTTP pour « List SCIM provisioned identities for an enterprise »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « List SCIM provisioned identities for an enterprise »
Exemple de requête
curl -L \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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.
Paramètres pour « Provision a SCIM enterprise user »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nom, Type, Description | |||||
---|---|---|---|---|---|
schemas array of strings ObligatoireThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||||
externalId string ObligatoireA unique identifier for the resource as defined by the provisioning client. | |||||
active boolean ObligatoireWhether the user active in the IdP. | |||||
userName string ObligatoireThe username for the user. | |||||
name object | |||||
Properties of |
Nom, Type, Description |
---|
formatted string The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. |
familyName string ObligatoireThe family name of the user. |
givenName string ObligatoireThe given name of the user. |
middleName string The middle name(s) of the user. |
displayName
string ObligatoireA human-readable name for the user.
emails
array of objects ObligatoireThe emails for the user.
Properties of emails
Nom, Type, Description |
---|
value string ObligatoireThe email address. |
type string ObligatoireThe type of email address. |
primary boolean ObligatoireWhether this email address is the primary address. |
roles
array of objects The roles assigned to the user.
Properties of roles
Nom, Type, Description |
---|
display string |
type string |
value string ObligatoireThe role value representing a user role in GitHub. Peut être: |
primary boolean Is the role a primary role for the user. |
Codes d’état de la réponse HTTP pour « Provision a SCIM enterprise user »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « Provision a SCIM enterprise user »
Exemples de requête
curl -L \
-X POST \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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.
Paramètres pour « Get SCIM provisioning information for an enterprise user »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
scim_user_id string ObligatoireThe unique identifier of the SCIM user. |
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Codes d’état de la réponse HTTP pour « Get SCIM provisioning information for an enterprise user »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « Get SCIM provisioning information for an enterprise user »
Exemple de requête
curl -L \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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.
Paramètres pour « Set SCIM information for a provisioned enterprise user »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
scim_user_id string ObligatoireThe unique identifier of the SCIM user. |
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nom, Type, Description | |||||
---|---|---|---|---|---|
schemas array of strings ObligatoireThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||||
externalId string ObligatoireA unique identifier for the resource as defined by the provisioning client. | |||||
active boolean ObligatoireWhether the user active in the IdP. | |||||
userName string ObligatoireThe username for the user. | |||||
name object | |||||
Properties of |
Nom, Type, Description |
---|
formatted string The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. |
familyName string ObligatoireThe family name of the user. |
givenName string ObligatoireThe given name of the user. |
middleName string The middle name(s) of the user. |
displayName
string ObligatoireA human-readable name for the user.
emails
array of objects ObligatoireThe emails for the user.
Properties of emails
Nom, Type, Description |
---|
value string ObligatoireThe email address. |
type string ObligatoireThe type of email address. |
primary boolean ObligatoireWhether this email address is the primary address. |
roles
array of objects The roles assigned to the user.
Properties of roles
Nom, Type, Description |
---|
display string |
type string |
value string ObligatoireThe role value representing a user role in GitHub. Peut être: |
primary boolean Is the role a primary role for the user. |
Codes d’état de la réponse HTTP pour « Set SCIM information for a provisioned enterprise user »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « Set SCIM information for a provisioned enterprise user »
Exemple de requête
curl -L \
-X PUT \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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
}
}]
}
Paramètres pour « Update an attribute for a SCIM enterprise user »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
scim_user_id string ObligatoireThe unique identifier of the SCIM user. |
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Nom, Type, Description | ||||
---|---|---|---|---|
Operations array of objects Obligatoirepatch operations list | ||||
Properties of |
Nom, Type, Description |
---|
op string ObligatoirePeut être: |
path string |
value string Corresponding 'value' of that field specified by 'path' |
schemas
array of strings ObligatoireundefinedSupported values are: urn:ietf:params:scim:api:messages:2.0:PatchOp
Codes d’état de la réponse HTTP pour « Update an attribute for a SCIM enterprise user »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « Update an attribute for a SCIM enterprise user »
Exemples de requête
curl -L \
-X PATCH \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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.
Paramètres pour « Delete a SCIM user from an enterprise »
Nom, Type, Description |
---|
accept string Setting to |
Nom, Type, Description |
---|
scim_user_id string ObligatoireThe unique identifier of the SCIM user. |
enterprise string ObligatoireThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Codes d’état de la réponse HTTP pour « Delete a SCIM user from an enterprise »
Code d’état | Description |
---|---|
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 |
Exemples de code pour « Delete a SCIM user from an enterprise »
Exemple de requête
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Users/SCIM_USER_ID
User was deleted, no content
Status: 204