Эта версия GitHub Enterprise Server была прекращена 2024-07-09. Исправления выпускаться не будут даже при критических проблемах безопасности. Для повышения производительности, повышения безопасности и новых функций выполните обновление до последней версии GitHub Enterprise Server. Чтобы получить справку по обновлению, обратитесь в службу поддержки GitHub Enterprise.
Конечные точки REST API для SCIM
Используйте REST API для автоматизации создания пользователей и членства в группах с помощью SCIM.
Общие сведения о SCIM
Примечание. SCIM для GitHub Enterprise Server в настоящее время находится в закрытой бета-версии и подлежит изменению. Чтобы получить доступ к бета-версии, обратитесь к менеджеру по учетным записям на Команда по продажам GitHub. Укажите отзыв в обсуждении GitHub Community.
Предупреждение. Бета-версия доступна исключительно для тестирования и обратной связи, а поддержка недоступна. GitHub рекомендует тестировать с помощью промежуточный экземпляр. Дополнительные сведения см. в разделе Настройка промежуточного экземпляра.
GitHub Enterprise Server предоставляет конечные точки для использования поставщиками удостоверений с поддержкой SCIM (поставщики удостоверений). Интеграция с поставщиком удостоверений может использовать REST API для автоматической подготовки учетных записей пользователей, управления и отмены подготовки учетных записей пользователей на экземпляре GitHub Enterprise Server с использованием единого входа SAML для проверки подлинности. Дополнительные сведения о едином входе SAML см. в разделе "Сведения о SAML для корпоративной системы IAM".
Эти конечные точки основаны на SCIM 2.0. Дополнительные сведения см. в документации поставщика удостоверений или спецификации на веб-сайте IETF.
Url-адреса корневого каталога
Идентификатор поставщика удостоверений может использовать следующий корневой URL-адрес для взаимодействия с конечными точками в этой категории для экземпляра GitHub Enterprise Server .
http(s)://HOSTNAME/api/v3/scim/v2/
Конечные точки в этой категории чувствительны к регистру. Например, первая буква в конечной точке Users
должна быть прописной.
GET /scim/v2/Users/{scim_user_id}
Проверка подлинности
Интеграция SCIM с idP выполняет действия от имени владельца предприятия для экземпляра GitHub Enterprise Server. Дополнительные сведения см. в разделе Роли на предприятии.
Чтобы пройти проверку подлинности запросов API, пользователь, который настраивает SCIM в idP, должен использовать personal access token с admin:enterprise
областью действия, которую idP должен предоставить в заголовке запроса Authorization
. Дополнительные сведения о personal access tokensсм. в разделе "Управление личными маркерами доступа".
Примечание. Владельцы предприятия должны создавать и использовать personal access token для проверки подлинности запросов к конечным точкам в этой категории. Fine-grained personal access token и вызывающие приложения GitHub в настоящее время не поддерживаются.
Сопоставление данных SAML и SCIM
Экземпляр GitHub Enterprise Server связывает каждого пользователя, успешно прошедшего проверку подлинности с помощью единого входа SAML, к удостоверению SCIM. Чтобы связать удостоверения успешно, samL IdP и интеграция SCIM должны использовать соответствующие значения SAML NameID
и SCIM userName
для каждого пользователя.
Примечание. Если GitHub Enterprise Server использует идентификатор записи в качестве поставщика удостоверений SAML, GitHub Enterprise Server также проверяет утверждение SCIM externalId
и утверждение SAML http://schemas.microsoft.com/identity/claims/objectidentifier
для сопоставления пользователей, а не использования NameID
и userName
.
Поддерживаемые атрибуты пользователя SCIM
User
конечные точки в этой категории поддерживают следующие атрибуты в параметрах запроса.
Имя. | Тип | Описание: |
---|---|---|
displayName | Строка | Читаемое пользователем имя. |
name.formatted | Строка | Полное имя пользователя, включая все имена, названия и суффиксы, отформатированные для отображения. |
name.givenName | Строка | Имя пользователя. |
name.familyName | Строка | Фамилия пользователя. |
userName | Строка | Имя пользователя, созданное идентификатором поставщика удостоверений. Проходит нормализацию перед использованием. |
emails | Массив | Список сообщений электронной почты пользователя. |
roles | Массив | Список ролей пользователя. |
externalId | Строка | Этот идентификатор создается поставщиком удостоверений. Вы можете найти externalId пользователя в idP или с помощью конечной точки подготовленных удостоверений списка SCIM и фильтрации по другим известным атрибутам, например имени пользователя или адреса электронной почты на экземпляре GitHub Enterprise Server . |
id | Строка | Идентификатор, созданный конечной точкой SCIM экземпляра. |
active | Логический | Указывает, является ли удостоверение активным (true ) или должно быть приостановлено (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.
Параметры для "List provisioned SCIM groups for an enterprise"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, 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. По умолчанию.: |
count integer Used for pagination: the number of results to return per page. По умолчанию.: |
Коды состояния http-ответа для "List provisioned SCIM groups for an enterprise"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "List provisioned SCIM groups for an enterprise"
Пример запроса
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.
Параметры для "Provision a SCIM enterprise group"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, Description | |||
---|---|---|---|
schemas array of strings Обязательное полеThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||
externalId string Обязательное полеA unique identifier for the resource as defined by the provisioning client. | |||
displayName string Обязательное полеA human-readable name for a security group. | |||
members array of objects Обязательное полеThe group members. | |||
Properties of |
Имя., Тип, Description |
---|
value string Обязательное полеThe local unique identifier for the member |
displayName string Обязательное полеThe display name associated with the member |
Коды состояния http-ответа для "Provision a SCIM enterprise group"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "Provision a SCIM enterprise group"
Пример запроса
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.
Параметры для "Get SCIM provisioning information for an enterprise group"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
scim_group_id string Обязательное полеA unique identifier of the SCIM group. |
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, Description |
---|
excludedAttributes string Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. |
Коды состояния http-ответа для "Get SCIM provisioning information for an enterprise group"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "Get SCIM provisioning information for an enterprise group"
Пример запроса
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.
Параметры для "Set SCIM information for a provisioned enterprise group"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
scim_group_id string Обязательное полеA unique identifier of the SCIM group. |
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, Description | |||
---|---|---|---|
schemas array of strings Обязательное полеThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||
externalId string Обязательное полеA unique identifier for the resource as defined by the provisioning client. | |||
displayName string Обязательное полеA human-readable name for a security group. | |||
members array of objects Обязательное полеThe group members. | |||
Properties of |
Имя., Тип, Description |
---|
value string Обязательное полеThe local unique identifier for the member |
displayName string Обязательное полеThe display name associated with the member |
Коды состояния http-ответа для "Set SCIM information for a provisioned enterprise group"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "Set SCIM information for a provisioned enterprise group"
Примеры запросов
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.
Параметры для "Update an attribute for a SCIM enterprise group"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
scim_group_id string Обязательное полеA unique identifier of the SCIM group. |
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, Description | ||||
---|---|---|---|---|
Operations array of objects Обязательное полеpatch operations list | ||||
Properties of |
Имя., Тип, Description |
---|
op string Обязательное полеВозможные значения: |
path string |
value string Corresponding 'value' of that field specified by 'path' |
schemas
array of strings Обязательное полеundefinedSupported values are: urn:ietf:params:scim:api:messages:2.0:PatchOp
Коды состояния http-ответа для "Update an attribute for a SCIM enterprise group"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "Update an attribute for a SCIM enterprise group"
Примеры запросов
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.
Параметры для "Delete a SCIM group from an enterprise"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
scim_group_id string Обязательное полеA unique identifier of the SCIM group. |
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Коды состояния http-ответа для "Delete a SCIM group from an enterprise"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "Delete a SCIM group from an enterprise"
Пример запроса
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.
Параметры для "List SCIM provisioned identities for an enterprise"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, 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. По умолчанию.: |
count integer Used for pagination: the number of results to return per page. По умолчанию.: |
Коды состояния http-ответа для "List SCIM provisioned identities for an enterprise"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "List SCIM provisioned identities for an enterprise"
Пример запроса
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.
Параметры для "Provision a SCIM enterprise user"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, Description | |||||
---|---|---|---|---|---|
schemas array of strings Обязательное полеThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||||
externalId string Обязательное полеA unique identifier for the resource as defined by the provisioning client. | |||||
active boolean Обязательное полеWhether the user active in the IdP. | |||||
userName string Обязательное полеThe username for the user. | |||||
name object | |||||
Properties of |
Имя., Тип, Description |
---|
formatted string The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. |
familyName string Обязательное полеThe family name of the user. |
givenName string Обязательное полеThe given name of the user. |
middleName string The middle name(s) of the user. |
displayName
string Обязательное полеA human-readable name for the user.
emails
array of objects Обязательное полеThe emails for the user.
Properties of emails
Имя., Тип, Description |
---|
value string Обязательное полеThe email address. |
type string Обязательное полеThe type of email address. |
primary boolean Обязательное полеWhether this email address is the primary address. |
roles
array of objects The roles assigned to the user.
Properties of roles
Имя., Тип, Description |
---|
display string |
type string |
value string Обязательное полеThe role value representing a user role in GitHub. Возможные значения: |
primary boolean Is the role a primary role for the user. |
Коды состояния http-ответа для "Provision a SCIM enterprise user"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "Provision a SCIM enterprise user"
Примеры запросов
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.
Параметры для "Get SCIM provisioning information for an enterprise user"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
scim_user_id string Обязательное полеThe unique identifier of the SCIM user. |
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Коды состояния http-ответа для "Get SCIM provisioning information for an enterprise user"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "Get SCIM provisioning information for an enterprise user"
Пример запроса
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.
Параметры для "Set SCIM information for a provisioned enterprise user"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
scim_user_id string Обязательное полеThe unique identifier of the SCIM user. |
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, Description | |||||
---|---|---|---|---|---|
schemas array of strings Обязательное полеThe URIs that are used to indicate the namespaces of the SCIM schemas.
Supported values are: | |||||
externalId string Обязательное полеA unique identifier for the resource as defined by the provisioning client. | |||||
active boolean Обязательное полеWhether the user active in the IdP. | |||||
userName string Обязательное полеThe username for the user. | |||||
name object | |||||
Properties of |
Имя., Тип, Description |
---|
formatted string The full name, including all middle names, titles, and suffixes as appropriate, formatted for display. |
familyName string Обязательное полеThe family name of the user. |
givenName string Обязательное полеThe given name of the user. |
middleName string The middle name(s) of the user. |
displayName
string Обязательное полеA human-readable name for the user.
emails
array of objects Обязательное полеThe emails for the user.
Properties of emails
Имя., Тип, Description |
---|
value string Обязательное полеThe email address. |
type string Обязательное полеThe type of email address. |
primary boolean Обязательное полеWhether this email address is the primary address. |
roles
array of objects The roles assigned to the user.
Properties of roles
Имя., Тип, Description |
---|
display string |
type string |
value string Обязательное полеThe role value representing a user role in GitHub. Возможные значения: |
primary boolean Is the role a primary role for the user. |
Коды состояния http-ответа для "Set SCIM information for a provisioned enterprise user"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "Set SCIM information for a provisioned enterprise user"
Пример запроса
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
}
}]
}
Параметры для "Update an attribute for a SCIM enterprise user"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
scim_user_id string Обязательное полеThe unique identifier of the SCIM user. |
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Имя., Тип, Description | ||||
---|---|---|---|---|
Operations array of objects Обязательное полеpatch operations list | ||||
Properties of |
Имя., Тип, Description |
---|
op string Обязательное полеВозможные значения: |
path string |
value string Corresponding 'value' of that field specified by 'path' |
schemas
array of strings Обязательное полеundefinedSupported values are: urn:ietf:params:scim:api:messages:2.0:PatchOp
Коды состояния http-ответа для "Update an attribute for a SCIM enterprise user"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "Update an attribute for a SCIM enterprise user"
Примеры запросов
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.
Параметры для "Delete a SCIM user from an enterprise"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
scim_user_id string Обязательное полеThe unique identifier of the SCIM user. |
enterprise string Обязательное полеThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Коды состояния http-ответа для "Delete a SCIM user from an enterprise"
Код состояния | Описание |
---|---|
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 |
Примеры кода для "Delete a SCIM user from an enterprise"
Пример запроса
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