Pontos de extremidade da API REST para SCIM

Sobre o SCIM

Note

Esta é uma versão desatualizada, beta privada do SCIM para GitHub Enterprise Server. Os clientes devem atualizar para a versão 3.14 ou mais recente e usar o SCIM GitHub Enterprise Server beta para que seus comentários sobre o SCIM ou relatórios de bugs sejam considerados.

Warning

O beta é exclusivamente para teste e feedback, e não está disponível nenhum suporte. O GitHub recomenda fazer testes com uma instância de preparo. Para obter mais informações, confira "Configurar uma instância de preparo".

Esses pontos de extremidade só dão suporte à autenticação por meio de um personal access token (classic). Para obter mais informações, confira "Gerenciar seus tokens de acesso pessoal".

O GitHub Enterprise Server fornece pontos de extremidade para uso pelos IdPs (provedores de identidade) habilitados para SCIM. Uma integração no IdP pode usar a API REST para provisionar, gerenciar ou desprovisionar automaticamente contas de usuário em uma instância do GitHub Enterprise Server que usa o SSO (logon único) do SAML para autenticação. Confira "Configurando o provisionamento de usuários com o SCIM no GitHub Enterprise Server".

Esses pontos de extremidade são baseados no SCIM 2.0. Para obter mais informações, confira a documentação do IdP ou confira a especificação no site do IETF.

URLs raiz

Um IdP pode usar a URL raiz a seguir para se comunicar com os pontos de extremidade desta categoria em uma instância do GitHub Enterprise Server.

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

Não inclua a parte enterprises/{enterprise}/ das URLs fornecidas na documentação do ponto de extremidade abaixo. Esta parte do caminho não é aplicável ao GitHub Enterprise Server. No futuro, esta documentação exibirá as URLs corretas para GitHub Enterprise Server.

Os pontos de extremidade desta categoria diferenciam maiúsculas de minúsculas. Por exemplo, a primeira letra no ponto de extremidade Users precisa ser maiúscula.

GET /scim/v2/Users/{scim_user_id}

Autenticação

A integração do SCIM no IdP executa ações em nome de um proprietário corporativo na instância do GitHub Enterprise Server. Para obter mais informações, confira "Funções em uma empresa".

Para autenticar as solicitações da API, a pessoa que configura o SCIM no IdP precisa usar um personal access token (classic) com o escopo admin:enterprise, que o IdP precisa fornecer no cabeçalho Authorization da solicitação. Para obter mais informações sobre personal access tokens (classic), confira "Gerenciar seus tokens de acesso pessoal".

Observação: os proprietários corporativos precisam gerar e usar um personal access token (classic) para a autenticação de solicitações aos pontos de extremidade desta categoria. No momento, não há suporte para os chamadores Fine-grained personal access token e do aplicativo do GitHub.

Mapear dados do SAML e SCIM

A instância do GitHub Enterprise Server vincula cada usuário que se autentica com êxito com o SSO do SAML a uma identidade do SCIM. Para vincular as identidades com êxito, o IdP do SAML e a integração ao SCIM precisam usar os de valores NameID do SAML e de userName do SCIM correspondentes para cada usuário.

Observação: se o GitHub Enterprise Server usar o Entra ID como um IdP de SAML, o GitHub Enterprise Server também verificará a declaração de externalId do SCIM e a declaração de http://schemas.microsoft.com/identity/claims/objectidentifier do SAML para corresponder primeiro aos usuários, em vez de usar NameID e userName.

Atributos de usuário do SCIM com suporte

Os pontos de extremidade de User desta categoria dão suporte aos atributos a seguir dentro dos parâmetros de uma solicitação.

Nome	Tipo	Descrição
`displayName`	String	Nome de usuário legível por pessoas.
`name.formatted`	String	O nome completo do usuário, incluindo todos os nomes do meio, títulos e sufixos, formatados para exibição.
`name.givenName`	String	Primeiro nome do usuário.
`name.familyName`	String	Sobrenome do usuário.
`userName`	String	O nome de usuário do usuário, gerado pelo IdP. Passa por normalização antes de ser usado.
`emails`	Array	Lista de emails do usuário.
`roles`	Array	Lista de funções do usuário.
`externalId`	String	Esse identificador é gerado por um provedor IdP. Você pode encontrar a `externalId` de um usuário no IdP ou usando o ponto de extremidade Listar identidades provisionadas do SCIM e a filtragem de outros atributos conhecidos, como o nome de usuário ou o endereço de email de um usuário na instância do GitHub Enterprise Server.
`id`	String	Identificador gerado pelo ponto de extremidade do SCIM da instância.
`active`	Booliano	Indica se a identidade está ativa (`true`) ou deve ser suspensa (`false`).

List provisioned SCIM groups for an enterprise

Note

The SCIM API endpoints for enterprise accounts are currently in private preview 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.

Tokens de acesso refinados para "List provisioned SCIM groups for an enterprise"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "List provisioned SCIM groups for an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Parâmetros de consulta
Nome, Tipo, Descrição
`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. Padrão: `1`
`count` integer Used for pagination: the number of results to return per page. Padrão: `30`

Códigos de status de resposta HTTP para "List provisioned SCIM groups for an enterprise"

Código de status	Descrição
`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

Exemplos de código para "List provisioned SCIM groups for an enterprise"

Exemplo de solicitação

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" \
  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 preview 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.

Tokens de acesso refinados para "Provision a SCIM enterprise group"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "Provision a SCIM enterprise group"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Nome, Tipo, Descrição

schemas array of strings Obrigatório

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 Obrigatório

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

displayName string Obrigatório

A human-readable name for a security group.

members array of objects Obrigatório

The group members.

Properties of members

Nome, Tipo, Descrição
`value` string Obrigatório The local unique identifier for the member
`displayName` string Obrigatório The display name associated with the member

Códigos de status de resposta HTTP para "Provision a SCIM enterprise group"

Código de status	Descrição
`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

Exemplos de código para "Provision a SCIM enterprise group"

Exemplo de solicitação

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" \
  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 preview and are subject to change.

Gets information about a SCIM group.

Tokens de acesso refinados para "Get SCIM provisioning information for an enterprise group"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "Get SCIM provisioning information for an enterprise group"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`scim_group_id` string Obrigatório A unique identifier of the SCIM group.
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Parâmetros de consulta
Nome, Tipo, Descrição
`excludedAttributes` string Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.

Códigos de status de resposta HTTP para "Get SCIM provisioning information for an enterprise group"

Código de status	Descrição
`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

Exemplos de código para "Get SCIM provisioning information for an enterprise group"

Exemplo de solicitação

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" \
  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 preview 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.

Tokens de acesso refinados para "Set SCIM information for a provisioned enterprise group"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "Set SCIM information for a provisioned enterprise group"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`scim_group_id` string Obrigatório A unique identifier of the SCIM group.
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Nome, Tipo, Descrição

schemas array of strings Obrigatório

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 Obrigatório

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

displayName string Obrigatório

A human-readable name for a security group.

members array of objects Obrigatório

The group members.

Properties of members

Nome, Tipo, Descrição
`value` string Obrigatório The local unique identifier for the member
`displayName` string Obrigatório The display name associated with the member

Códigos de status de resposta HTTP para "Set SCIM information for a provisioned enterprise group"

Código de status	Descrição
`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

Exemplos de código para "Set SCIM information for a provisioned enterprise group"

Exemplos de solicitação

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" \
  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 preview 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.

Tokens de acesso refinados para "Update an attribute for a SCIM enterprise group"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "Update an attribute for a SCIM enterprise group"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`scim_group_id` string Obrigatório A unique identifier of the SCIM group.
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Nome, Tipo, Descrição

Operations array of objects Obrigatório

patch operations list

Properties of Operations

Nome, Tipo, Descrição
`op` string Obrigatório Pode ser um dos: `add`, `replace`, `remove`
`path` string
`value` string Corresponding 'value' of that field specified by 'path'

schemas array of strings Obrigatório

undefinedSupported values are: urn:ietf:params:scim:api:messages:2.0:PatchOp

Códigos de status de resposta HTTP para "Update an attribute for a SCIM enterprise group"

Código de status	Descrição
`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

Exemplos de código para "Update an attribute for a SCIM enterprise group"

Exemplos de solicitação

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" \
  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 preview and are subject to change.

Deletes a SCIM group from an enterprise.

Tokens de acesso refinados para "Delete a SCIM group from an enterprise"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "Delete a SCIM group from an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`scim_group_id` string Obrigatório A unique identifier of the SCIM group.
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Códigos de status de resposta HTTP para "Delete a SCIM group from an enterprise"

Código de status	Descrição
`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

Exemplos de código para "Delete a SCIM group from an enterprise"

Exemplo de solicitação

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" \
  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 preview 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.

Tokens de acesso refinados para "List SCIM provisioned identities for an enterprise"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "List SCIM provisioned identities for an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Parâmetros de consulta
Nome, Tipo, Descrição
`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. Padrão: `1`
`count` integer Used for pagination: the number of results to return per page. Padrão: `30`

Códigos de status de resposta HTTP para "List SCIM provisioned identities for an enterprise"

Código de status	Descrição
`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

Exemplos de código para "List SCIM provisioned identities for an enterprise"

Exemplo de solicitação

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" \
  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 preview 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.

Tokens de acesso refinados para "Provision a SCIM enterprise user"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "Provision a SCIM enterprise user"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Nome, Tipo, Descrição

schemas array of strings Obrigatório

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 Obrigatório

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

active boolean Obrigatório

Whether the user active in the IdP.

userName string Obrigatório

The username for the user.

name object

Properties of name

Nome, Tipo, Descrição
`formatted` string The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
`familyName` string Obrigatório The family name of the user.
`givenName` string Obrigatório The given name of the user.
`middleName` string The middle name(s) of the user.

displayName string Obrigatório

A human-readable name for the user.

emails array of objects Obrigatório

The emails for the user.

Properties of emails

Nome, Tipo, Descrição
`value` string Obrigatório The email address.
`type` string Obrigatório The type of email address.
`primary` boolean Obrigatório Whether this email address is the primary address.

roles array of objects

The roles assigned to the user.

Properties of roles

Nome, Tipo, Descrição
`display` string
`type` string
`value` string Obrigatório The role value representing a user role in GitHub. Pode ser um dos: `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.

Códigos de status de resposta HTTP para "Provision a SCIM enterprise user"

Código de status	Descrição
`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

Exemplos de código para "Provision a SCIM enterprise user"

Exemplos de solicitação

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" \
  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 preview and are subject to change.

Gets information about a SCIM user.

Tokens de acesso refinados para "Get SCIM provisioning information for an enterprise user"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "Get SCIM provisioning information for an enterprise user"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`scim_user_id` string Obrigatório The unique identifier of the SCIM user.
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Códigos de status de resposta HTTP para "Get SCIM provisioning information for an enterprise user"

Código de status	Descrição
`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

Exemplos de código para "Get SCIM provisioning information for an enterprise user"

Exemplo de solicitação

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" \
  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 preview 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.

Tokens de acesso refinados para "Set SCIM information for a provisioned enterprise user"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "Set SCIM information for a provisioned enterprise user"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`scim_user_id` string Obrigatório The unique identifier of the SCIM user.
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Nome, Tipo, Descrição

schemas array of strings Obrigatório

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 Obrigatório

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

active boolean Obrigatório

Whether the user active in the IdP.

userName string Obrigatório

The username for the user.

name object

Properties of name

Nome, Tipo, Descrição
`formatted` string The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
`familyName` string Obrigatório The family name of the user.
`givenName` string Obrigatório The given name of the user.
`middleName` string The middle name(s) of the user.

displayName string Obrigatório

A human-readable name for the user.

emails array of objects Obrigatório

The emails for the user.

Properties of emails

Nome, Tipo, Descrição
`value` string Obrigatório The email address.
`type` string Obrigatório The type of email address.
`primary` boolean Obrigatório Whether this email address is the primary address.

roles array of objects

The roles assigned to the user.

Properties of roles

Nome, Tipo, Descrição
`display` string
`type` string
`value` string Obrigatório The role value representing a user role in GitHub. Pode ser um dos: `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.

Códigos de status de resposta HTTP para "Set SCIM information for a provisioned enterprise user"

Código de status	Descrição
`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

Exemplos de código para "Set SCIM information for a provisioned enterprise user"

Exemplo de solicitação

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" \
  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 preview 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
    }
  }]
}

Tokens de acesso refinados para "Update an attribute for a SCIM enterprise user"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "Update an attribute for a SCIM enterprise user"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`scim_user_id` string Obrigatório The unique identifier of the SCIM user.
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Nome, Tipo, Descrição

Operations array of objects Obrigatório

patch operations list

Properties of Operations

Nome, Tipo, Descrição
`op` string Obrigatório Pode ser um dos: `add`, `replace`, `remove`
`path` string
`value` string Corresponding 'value' of that field specified by 'path'

schemas array of strings Obrigatório

undefinedSupported values are: urn:ietf:params:scim:api:messages:2.0:PatchOp

Códigos de status de resposta HTTP para "Update an attribute for a SCIM enterprise user"

Código de status	Descrição
`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

Exemplos de código para "Update an attribute for a SCIM enterprise user"

Exemplos de solicitação

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" \
  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 preview 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.

Tokens de acesso refinados para "Delete a SCIM user from an enterprise"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Enterprise administration" business permissions (write)

Parâmetros para "Delete a SCIM user from an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.github+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`scim_user_id` string Obrigatório The unique identifier of the SCIM user.
`enterprise` string Obrigatório The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Códigos de status de resposta HTTP para "Delete a SCIM user from an enterprise"

Código de status	Descrição
`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

Exemplos de código para "Delete a SCIM user from an enterprise"

Exemplo de solicitação

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" \
  http(s)://HOSTNAME/api/v3/scim/v2/enterprises/ENTERPRISE/Users/SCIM_USER_ID

User was deleted, no content

Status: 204