Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.

SCIM

Используйте REST API для автоматизации создания пользователей и членства в командах с помощью SCIM.

Сведения о SCIM

Примечание: SCIM для GitHub Enterprise Server сейчас находится в закрытой бета-версии и может быть изменен. Чтобы получить доступ к бета-версии, обратитесь к менеджеру по работе с клиентами по адресу Отдел продаж GitHub. Оставьте отзыв в обсуждении сообщества GitHub.

Предупреждение: Бета-версия предназначена исключительно для тестирования и обратной связи, и поддержка недоступна. GitHub рекомендует выполнять тестирование с помощью промежуточного экземпляра. Дополнительные сведения см. в разделе Настройка экземпляра промежуточного процесса.

GitHub Enterprise Server предоставляет конечные точки для использования поставщиками удостоверений (IDP) с поддержкой SCIM. Интеграция с поставщиком удостоверений может использовать REST API для автоматической подготовки, администрирования или отзыва учетных записей пользователей в экземпляре GitHub Enterprise Server, который использует единый вход SAML для проверки подлинности. Дополнительные сведения о едином входе SAML см. в разделе Сведения о SAML для корпоративного IAM.

Эти конечные точки основаны на SCIM 2.0. Дополнительные сведения см. в спецификации.

Корневые URL-адреса

Поставщик удостоверений может использовать следующий корневой URL-адрес для связи с конечными точками в этой категории для экземпляра GitHub Enterprise Server.

http(s)://HOSTNAME/api/v3/scim/v2/

Конечные точки в этой категории чувствительны к регистру. Например, первая буква в конечной точке Users должна быть прописной.

GET /scim/v2/Users/{scim_user_id}

Проверка подлинности

Интеграция SCIM с поставщиком удостоверений выполняет действия от имени владельца предприятия для экземпляра GitHub Enterprise Server. Дополнительные сведения см. в разделе Роли в организации.

Для проверки подлинности запросов API пользователь, который настраивает SCIM для поставщика удостоверений, должен использовать personal access token с admin:enterprise областью, которую поставщик удостоверений должен указать в заголовке Authorization запроса. Дополнительные сведения о personal access tokens см. в разделе Создание personal access token.

Примечание: Владельцы предприятия должны создать и использовать personal access token для проверки подлинности запросов к конечным точкам в этой категории. Вызывающие приложения GitHub в настоящее время не поддерживаются.

Сопоставление данных SAML и SCIM

Экземпляр GitHub Enterprise Server связывает каждого пользователя, успешно прошедшего проверку подлинности с помощью единого входа SAML, с удостоверением SCIM. Для успешного связывания удостоверений поставщик удостоверений SAML и интеграция SCIM должны использовать соответствующие значения SAML NameID и SCIM userName для каждого пользователя.

Поддерживаемые атрибуты пользователя SCIM

User Конечные точки в этой категории поддерживают следующие атрибуты в параметрах запроса.

ИмяТипОписание
displayNameСтрокаПонятное имя пользователя.
name.formattedСтрокаПолное имя пользователя, включая все отчество, названия и суффиксы, отформатированные для отображения.
name.givenNameСтрокаИмя пользователя.
name.familyNameСтрокаФамилия пользователя.
userNameСтрокаИмя пользователя, созданное поставщиком удостоверений. Перед использованием проходит нормализацию .
emailsArrayСписок сообщений электронной почты пользователя.
rolesArrayСписок ролей пользователя.
externalIdСтроковый типЭтот идентификатор создается поставщиком удостоверений. Вы можете найти externalId для пользователя либо в поставщике удостоверений, либо с помощью конечной точки list SCIM provisioned identities и фильтрации по другим известным атрибутам, таким как имя пользователя или адрес электронной почты пользователя в экземпляре GitHub Enterprise Server.
idСтрокаИдентификатор, созданный конечной точкой SCIM экземпляра.
activeЛогическоеУказывает, является ли удостоверение активным (true) или должно быть приостановлено (false).

List provisioned SCIM groups for an enterprise

Работа с GitHub Apps

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.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры запроса
Имя, Тип, Описание
filterstring

If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are externalId, id, and displayName. For example, ?filter="externalId eq '9138790-10932-109120392-12321'".

excludedAttributesstring

Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.

startIndexinteger

Used for pagination: the starting index of the first result to return when paginating through values.

Значение по умолчанию: 1

countinteger

Used for pagination: the number of results to return per page.

Значение по умолчанию: 30

Коды состояния HTTP-ответа

Код состоянияОписание
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

Примеры кода

get/scim/v2/Groups
curl \ -H "Accept: application/scim+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/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

Работа с GitHub Apps

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.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры запроса
Имя, Тип, Описание
schemasarray of stringsОбязательно

The URIs that are used to indicate the namespaces of the SCIM schemas.

externalIdstringОбязательно

A unique identifier for the resource as defined by the provisioning client.

displayNamestringОбязательно

A human-readable name for a security group.

membersarray of objectsОбязательно

The group members.

Имя, Тип, Описание
valuestringОбязательно

The local unique identifier for the member

displayNamestringОбязательно

The display name associated with the member

Коды состояния HTTP-ответа

Код состоянияОписание
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

Примеры кода

post/scim/v2/Groups
curl \ -X POST \ -H "Accept: application/scim+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/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

Работа с GitHub Apps

Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.

Gets information about a SCIM group.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Тип, Описание
scim_group_idstringОбязательно

A unique identifier of the SCIM group.

Параметры запроса
Имя, Тип, Описание
excludedAttributesstring

Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.

Коды состояния HTTP-ответа

Код состоянияОписание
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/v2/Groups/{scim_group_id}
curl \ -H "Accept: application/scim+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/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

Работа с GitHub Apps

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.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Тип, Описание
scim_group_idstringОбязательно

A unique identifier of the SCIM group.

Параметры запроса
Имя, Тип, Описание
schemasarray of stringsОбязательно

The URIs that are used to indicate the namespaces of the SCIM schemas.

externalIdstringОбязательно

A unique identifier for the resource as defined by the provisioning client.

displayNamestringОбязательно

A human-readable name for a security group.

membersarray of objectsОбязательно

The group members.

Имя, Тип, Описание
valuestringОбязательно

The local unique identifier for the member

displayNamestringОбязательно

The display name associated with the member

Коды состояния HTTP-ответа

Код состоянияОписание
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

Примеры кода

put/scim/v2/Groups/{scim_group_id}
curl \ -X PUT \ -H "Accept: application/scim+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/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

Работа с GitHub Apps

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.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Тип, Описание
scim_group_idstringОбязательно

A unique identifier of the SCIM group.

Параметры запроса
Имя, Тип, Описание
Operationsarray of objectsОбязательно

patch operations list

Имя, Тип, Описание
opstringОбязательно

Может быть одним из: add, replace, remove

pathstring
valuestring

Corresponding 'value' of that field specified by 'path'

schemasarray of stringsОбязательно

Коды состояния HTTP-ответа

Код состоянияОписание
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

Примеры кода

patch/scim/v2/Groups/{scim_group_id}
curl \ -X PATCH \ -H "Accept: application/scim+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/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

Работа с GitHub Apps

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.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Тип, Описание
scim_group_idstringОбязательно

A unique identifier of the SCIM group.

Коды состояния HTTP-ответа

Код состоянияОписание
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/scim/v2/Groups/{scim_group_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/Groups/SCIM_GROUP_ID

Group was deleted, no content

Status: 204

List SCIM provisioned identities for an enterprise

Работа с GitHub Apps

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.

You can improve query search time by using the excludedAttributes query parameter with a value of groups to exclude groups from the response.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры запроса
Имя, Тип, Описание
filterstring

If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are userName, externalId, id, and displayName. For example, ?filter="externalId eq '9138790-10932-109120392-12321'".

excludedAttributesstring

Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.

startIndexinteger

Used for pagination: the starting index of the first result to return when paginating through values.

Значение по умолчанию: 1

countinteger

Used for pagination: the number of results to return per page.

Значение по умолчанию: 30

Коды состояния HTTP-ответа

Код состоянияОписание
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

Примеры кода

get/scim/v2/Users
curl \ -H "Accept: application/scim+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/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

Работа с GitHub Apps

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.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры запроса
Имя, Тип, Описание
schemasarray of stringsОбязательно

The URIs that are used to indicate the namespaces of the SCIM schemas.

externalIdstringОбязательно

A unique identifier for the resource as defined by the provisioning client.

activebooleanОбязательно

Whether the user active in the IdP.

userNamestringОбязательно

The username for the user.

nameobject
Имя, Тип, Описание
formattedstring

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

familyNamestringОбязательно

The family name of the user.

givenNamestringОбязательно

The given name of the user.

middleNamestring

The middle name(s) of the user.

displayNamestringОбязательно

A human-readable name for the user.

emailsarray of objectsОбязательно

The emails for the user.

Имя, Тип, Описание
valuestringОбязательно

The email address.

typestringОбязательно

The type of email address.

primarybooleanОбязательно

Whether this email address is the primary address.

rolesarray of objects

The roles assigned to the user.

Имя, Тип, Описание
displaystring
typestring
valuestringОбязательно

The role value representing a user role in GitHub.

Может быть одним из: User, user, 27d9891d-2c17-4f45-a262-781a0e55c80a, Restricted User, restricted_user, 1ebc4a02-e56c-43a6-92a5-02ee09b90824, Enterprise Owner, enterprise_owner, 981df190-8801-4618-a08a-d91f6206c954, ba4987ab-a1c3-412a-b58c-360fc407cb10, Billing Manager, billing_manager, 0e338b8c-cc7f-498a-928d-ea3470d7e7e3, e6be2762-e4ad-4108-b72d-1bbe884a0f91

primaryboolean

Is the role a primary role for the user.

Коды состояния HTTP-ответа

Код состоянияОписание
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

Примеры кода

post/scim/v2/Users
curl \ -X POST \ -H "Accept: application/scim+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/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

Работа с GitHub Apps

Note: The SCIM API endpoints for enterprise accounts are currently in private beta and are subject to change.

Gets information about a SCIM user.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Тип, Описание
scim_user_idstringОбязательно

The unique identifier of the SCIM user.

Коды состояния HTTP-ответа

Код состоянияОписание
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/v2/Users/{scim_user_id}
curl \ -H "Accept: application/scim+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/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

Работа с GitHub Apps

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.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Тип, Описание
scim_user_idstringОбязательно

The unique identifier of the SCIM user.

Параметры запроса
Имя, Тип, Описание
schemasarray of stringsОбязательно

The URIs that are used to indicate the namespaces of the SCIM schemas.

externalIdstringОбязательно

A unique identifier for the resource as defined by the provisioning client.

activebooleanОбязательно

Whether the user active in the IdP.

userNamestringОбязательно

The username for the user.

nameobject
Имя, Тип, Описание
formattedstring

The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

familyNamestringОбязательно

The family name of the user.

givenNamestringОбязательно

The given name of the user.

middleNamestring

The middle name(s) of the user.

displayNamestringОбязательно

A human-readable name for the user.

emailsarray of objectsОбязательно

The emails for the user.

Имя, Тип, Описание
valuestringОбязательно

The email address.

typestringОбязательно

The type of email address.

primarybooleanОбязательно

Whether this email address is the primary address.

rolesarray of objects

The roles assigned to the user.

Имя, Тип, Описание
displaystring
typestring
valuestringОбязательно

The role value representing a user role in GitHub.

Может быть одним из: User, user, 27d9891d-2c17-4f45-a262-781a0e55c80a, Restricted User, restricted_user, 1ebc4a02-e56c-43a6-92a5-02ee09b90824, Enterprise Owner, enterprise_owner, 981df190-8801-4618-a08a-d91f6206c954, ba4987ab-a1c3-412a-b58c-360fc407cb10, Billing Manager, billing_manager, 0e338b8c-cc7f-498a-928d-ea3470d7e7e3, e6be2762-e4ad-4108-b72d-1bbe884a0f91

primaryboolean

Is the role a primary role for the user.

Коды состояния HTTP-ответа

Код состоянияОписание
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

Примеры кода

put/scim/v2/Users/{scim_user_id}
curl \ -X PUT \ -H "Accept: application/scim+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/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

Работа с GitHub Apps

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
    }
  }]
}

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Тип, Описание
scim_user_idstringОбязательно

The unique identifier of the SCIM user.

Параметры запроса
Имя, Тип, Описание
Operationsarray of objectsОбязательно

patch operations list

Имя, Тип, Описание
opstringОбязательно

Может быть одним из: add, replace, remove

pathstring
valuestring

Corresponding 'value' of that field specified by 'path'

schemasarray of stringsОбязательно

Коды состояния HTTP-ответа

Код состоянияОписание
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

Примеры кода

patch/scim/v2/Users/{scim_user_id}
curl \ -X PATCH \ -H "Accept: application/scim+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/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

Работа с GitHub Apps

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.

Параметры

Заголовки
Имя, Тип, Описание
acceptstring

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Тип, Описание
scim_user_idstringОбязательно

The unique identifier of the SCIM user.

Коды состояния HTTP-ответа

Код состоянияОписание
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/scim/v2/Users/{scim_user_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/scim/v2/Users/SCIM_USER_ID

User was deleted, no content

Status: 204