Конечные точки REST API для SCIM

Примечание.

*

GitHub рекомендует тестировать подготовку в среде, изолированной от рабочих данных в idP и GitHub.

Общие сведения о SCIM

Чтобы создать, управлять и деактивировать учетные записи пользователей для участников предприятия на GitHub, ваш идентификатор idP должен реализовать SCIM для связи с GitHub. SCIM — это открытая спецификация для управления удостоверениями пользователей между системами. Различные поставщики удостоверений предоставляют различные возможности для настройки подготовки SCIM. Если вы не используете поставщика удостоверений партнера с существующей интеграцией, можно интегрировать с помощью следующих конечных точек API. Дополнительные сведения см. в разделе Подготовка пользователей и групп с помощью SCIM с помощью REST API.

Базовый URL-адрес

Чтобы управлять пользователями и группами предприятия с помощью SCIM, используйте следующий базовый URL-адрес для взаимодействия с конечными точками в этой категории.

https://api.github.com/scim/v2/enterprises/{enterprise}/

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

Чтобы пройти проверку подлинности запросов API, пользователь, который настраивает SCIM в idP, должен использовать personal access token (classic) с scim:enterprise областью действия, которую idP должен предоставить в заголовке запроса Authorization . Дополнительные сведения о personal access tokens (classic)см. в разделе Управление личными маркерами доступа.

GitHub рекомендует проверку подлинности в качестве пользователя установки для предприятия. Другие учетные записи пользователей создаются с помощью SCIM, поэтому проверка подлинности в качестве другого пользователя может привести к непредвиденным последствиям, таким как блокировка из вашего предприятия. Запросы на запись в эти API можно выполнять через опубликованные приложения поставщика удостоверений или через прямой доступ API к конечным точкам SCIM. Если другой владелец предприятия должен считывать сведения из API, используйте personal access token (classic) с admin:enterprise областью действия для выполнения GET запросов к текущей реализации SCIM. Дополнительные сведения см. в разделе Настройка подготовки SCIM for Enterprise Managed Users.

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

После успешной проверки подлинности управляемая учетная запись пользователя для доступа к организации с помощью единого входа SAML GitHub связывает пользователя с подготовленным удостоверением SCIM. Чтобы связать удостоверения успешно, поставщик удостоверений SAML и интеграция SCIM должны использовать соответствующие уникальные идентификаторы.

GitHub требует следующего утверждения SAML и атрибута SCIM для успешного сопоставления пользователя с удостоверением, подготовленным SCIM. Поставщики удостоверений могут отличаться в поле, используемом для уникального идентификации пользователя.

Идентификатор Microsoft Entra для SAML

Чтобы использовать идентификатор записи (ранее известный как Azure AD) для SAML, необходимо соответствовать следующим утверждениям SAML и атрибуту SCIM.

Утверждение SAML	Сопоставление атрибута SCIM
`http://schemas.microsoft.com/identity/claims/objectidentifier`	`externalId`

Другие поставщики удостоверений для SAML

Чтобы использовать другие поставщики удостоверений для SAML, необходимо соответствовать следующим утверждениям SAML и атрибуту SCIM.

Утверждение SAML	Сопоставление атрибута SCIM
`NameID`	`userName`

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

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

Имя.	Тип	Описание:
`displayName`	Строка	Читаемое пользователем имя.
`name.formatted`	Строка	Полное имя пользователя, включая все имена, названия и суффиксы, отформатированные для отображения.
`name.givenName`	Строка	Имя пользователя.
`name.familyName`	Строка	Фамилия пользователя.
`userName`	Строка	Имя пользователя, созданное поставщиком SCIM. Проходит нормализацию перед использованием. Должен быть уникальным для каждого пользователя.
`emails`	Массив	Список сообщений электронной почты пользователя.
`roles`	Массив	Список ролей пользователя.
`externalId`	Строка	Этот идентификатор создается поставщиком SCIM. Должен быть уникальным для каждого пользователя.
`id`	Строка	Идентификатор, созданный конечной точкой SCIM GitHub.
`active`	Логический	Указывает, является ли удостоверение активным (`true`) или должно быть приостановлено (`false`).

Поддерживаемые атрибуты группы SCIM

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

Имя.	Тип	Описание:
`displayName`	Строка	Имя, доступное для чтения человеком для группы.
`members`	Строка	Список участников, назначенных группе в поставщике SCIM
`externalId`	Строка	Этот идентификатор создается поставщиком SCIM. Должен быть уникальным для каждого пользователя.

List provisioned SCIM groups for an enterprise

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

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (read)

Параметры для "List provisioned SCIM groups for an enterprise"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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 `externalId`, `id`, and `displayName`. For example, `?filter=externalId eq "9138790-10932-109120392-12321"`.
`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. По умолчанию.: `1`
`count` integer Used for pagination: the number of results to return per page. По умолчанию.: `30`

Коды состояния 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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/scim/v2/enterprises/{enterprise}/Groups

curl -L \
  -H "Accept: application/scim+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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": "24b28bbb-5fc4-4686-a153-a020debb1155",
      "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/24b28bbb-5fc4-4686-a153-a020debb1155"
      }
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 20
}

Provision a SCIM enterprise group

Creates a SCIM group for an enterprise.

When members are part of the group provisioning payload, they're designated as external group members. Providers are responsible for maintaining a mapping between the externalId and id for each user.

Подробные маркеры доступа для "Provision a SCIM enterprise group

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (write)

Параметры для "Provision a SCIM enterprise group"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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: urn:ietf:params:scim:schemas:core:2.0:Group

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 members

Имя., Тип, 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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

post/scim/v2/enterprises/{enterprise}/Groups

curl -L \
  -X POST \
  -H "Accept: application/scim+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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/24b28bbb-5fc4-4686-a153-a020debb1155"
  }
}

Get SCIM provisioning information for an enterprise group

Gets information about a SCIM group.

Подробные маркеры доступа для "Get SCIM provisioning information for an enterprise group

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (read)

Параметры для "Get SCIM provisioning information for an enterprise group"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}

curl -L \
  -H "Accept: application/scim+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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/24b28bbb-5fc4-4686-a153-a020debb1155"
  }
}

Set SCIM information for a provisioned enterprise group

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

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (write)

Параметры для "Set SCIM information for a provisioned enterprise group"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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: urn:ietf:params:scim:schemas:core:2.0:Group

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 members

Имя., Тип, 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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Примеры запросов

Select the example type

put/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}

curl -L \
  -X PUT \
  -H "Accept: application/scim+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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/24b28bbb-5fc4-4686-a153-a020debb1155"
  }
}

Update an attribute for a SCIM enterprise group

Update a provisioned group’s individual attributes.

To modify a group's values, you'll need to use a specific Operations JSON format which must include at least one of the following operations: add, remove, or replace. For examples and more information on this SCIM format, consult the SCIM specification. The update function can also be used to add group memberships.

You can submit group memberships individually or in batches for improved efficiency.

Note

Memberships are referenced via a local user id. Ensure users are created before referencing them here.

Подробные маркеры доступа для "Update an attribute for a SCIM enterprise group

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (write)

Параметры для "Update an attribute for a SCIM enterprise group"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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 Operations

Имя., Тип, Description
`op` string Обязательное поле Возможные значения: `add`, `replace`, `remove`
`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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Примеры запросов

Select the example type

patch/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}

curl -L \
  -X PATCH \
  -H "Accept: application/scim+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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/24b28bbb-5fc4-4686-a153-a020debb1155"
  }
}

Delete a SCIM group from an enterprise

Deletes a SCIM group from an enterprise.

Подробные маркеры доступа для "Delete a SCIM group from an enterprise

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (write)

Параметры для "Delete a SCIM group from an enterprise"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

delete/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID

Group was deleted, no content

Status: 204

List SCIM provisioned identities for an enterprise

Lists provisioned SCIM enterprise members.

When you remove a user with a SCIM-provisioned external identity from an enterprise using a patch with active flag to false, the user's metadata remains intact. This means they can potentially re-join the enterprise later. Although, while suspended, the user can't sign in. If you want to ensure the user can't re-join in the future, use the delete request. Only users who weren't permanently deleted will appear in the result list.

Подробные маркеры доступа для "List SCIM provisioned identities for an enterprise

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (read)

Параметры для "List SCIM provisioned identities for an enterprise"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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 `userName`, `externalId`, `id`, and `displayName`. For example, `?filter=externalId eq "9138790-10932-109120392-12321"`.
`startIndex` integer Used for pagination: the starting index of the first result to return when paginating through values. По умолчанию.: `1`
`count` integer Used for pagination: the number of results to return per page. По умолчанию.: `30`

Коды состояния 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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/scim/v2/enterprises/{enterprise}/Users

curl -L \
  -H "Accept: application/scim+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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

Creates an external identity for a new SCIM enterprise user.

SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.

Подробные маркеры доступа для "Provision a SCIM enterprise user

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (write)

Параметры для "Provision a SCIM enterprise user"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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: urn:ietf:params:scim:schemas:core:2.0:User

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 name

Имя., Тип, 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. Возможные значения: `user`, `27d9891d-2c17-4f45-a262-781a0e55c80a`, `guest_collaborator`, `1ebc4a02-e56c-43a6-92a5-02ee09b90824`, `enterprise_owner`, `981df190-8801-4618-a08a-d91f6206c954`, `ba4987ab-a1c3-412a-b58c-360fc407cb10`, `billing_manager`, `0e338b8c-cc7f-498a-928d-ea3470d7e7e3`, `e6be2762-e4ad-4108-b72d-1bbe884a0f91`
`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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Примеры запросов

Select the example type

post/scim/v2/enterprises/{enterprise}/Users

curl -L \
  -X POST \
  -H "Accept: application/scim+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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

Gets information about a SCIM user.

Подробные маркеры доступа для "Get SCIM provisioning information for an enterprise user

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (read)

Параметры для "Get SCIM provisioning information for an enterprise user"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}

curl -L \
  -H "Accept: application/scim+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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

Replaces an existing provisioned user's information.

You must supply complete user information, just as you would when provisioning them initially. Any previously existing data not provided will be deleted. To update only a specific attribute, refer to the Update an attribute for a SCIM user endpoint.

Warning

Setting active: false will suspend a user, and their handle and email will be obfuscated.

Подробные маркеры доступа для "Set SCIM information for a provisioned enterprise user

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (write)

Параметры для "Set SCIM information for a provisioned enterprise user"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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: urn:ietf:params:scim:schemas:core:2.0:User

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 name

Имя., Тип, 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. Возможные значения: `user`, `27d9891d-2c17-4f45-a262-781a0e55c80a`, `guest_collaborator`, `1ebc4a02-e56c-43a6-92a5-02ee09b90824`, `enterprise_owner`, `981df190-8801-4618-a08a-d91f6206c954`, `ba4987ab-a1c3-412a-b58c-360fc407cb10`, `billing_manager`, `0e338b8c-cc7f-498a-928d-ea3470d7e7e3`, `e6be2762-e4ad-4108-b72d-1bbe884a0f91`
`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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

put/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}

curl -L \
  -X PUT \
  -H "Accept: application/scim+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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

Update a provisioned user's individual attributes.

To modify a user's attributes, you'll need to provide a Operations JSON formatted request that includes at least one of the following actions: add, remove, or replace. For specific examples and more information on the SCIM operations format, please refer to the SCIM specification.

Note

Complex SCIM path selectors that include filters are not supported. For example, a path selector defined as "path": "emails[type eq \"work\"]" will be ineffective.

Warning

Setting active: false will suspend a user, and their handle and email will be obfuscated.

{
  "Operations":[{
    "op":"replace",
    "value":{
      "active":false
    }
  }]
}

Подробные маркеры доступа для "Update an attribute for a SCIM enterprise user

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (write)

Параметры для "Update an attribute for a SCIM enterprise user"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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 Operations

Имя., Тип, Description
`op` string Обязательное поле Возможные значения: `add`, `replace`, `remove`
`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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Примеры запросов

Select the example type

patch/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}

curl -L \
  -X PATCH \
  -H "Accept: application/scim+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/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

Suspends a SCIM user permanently from an enterprise. This action will: remove all the user's data, anonymize their login, email, and display name, erase all external identity SCIM attributes, delete the user's emails, avatar, PATs, SSH keys, OAuth authorizations, GPG keys, and SAML mappings. This action is irreversible.

Подробные маркеры доступа для "Delete a SCIM user from an enterprise

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Enterprise SCIM" business permissions (write)

Параметры для "Delete a SCIM user from an enterprise"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, 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"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

delete/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Users/SCIM_USER_ID

User was deleted, no content

Status: 204