我们经常发布文档更新，此页面的翻译可能仍在进行中。有关最新信息，请访问英文文档。如果此页面上的翻译有问题，请告诉我们。

按产品浏览

REST API
简体中文 (Simplified Chinese)
文章版本： GitHub.com
GitHub.com Enterprise Server 2.22 Enterprise Server 2.21 Enterprise Server 2.20 Enterprise Server 2.19

GitHub Enterprise administration

本文内容

Did this doc help you?

You can use these GitHub Enterprise Cloud endpoints to administer your enterprise account.

Note: This article applies to GitHub Enterprise Cloud. To see the GitHub Enterprise Server version, use the 文章版本： drop-down menu.

SCIM

SCIM Provisioning for Enterprises

SCIM-enabled Identity Providers (IdPs) can use the SCIM API to automate the provisioning of enterprise membership. GitHub API 基于SCIM 标准的 2.0 版本。

The IdP must use https://api.github.com/scim/v2/enterprises/{enterprise}/ as the SCIM endpoint.

Note: The enterprise SCIM API is only available to enterprises on GitHub Enterprise Cloud with SAML SSO enabled. 有关 SCIM 的更多信息，请参阅“关于 SCIM”。

向 SCIM API 验证调用

You must authenticate as an owner of a GitHub enterprise to use its SCIM API. API 预期 OAuth 2.0 Bearer 令牌包含在授权标头中。 You may also use a personal access token, but you must first authorize it for use with your SAML SSO enterprise.

SAML 和 SCIM 数据的映射

The SAML IdP and the SCIM client must use matching NameID and userName values for each user. This allows a user authenticating through SAML to be linked to their provisioned SCIM identity.

SCIM groups are matched with GitHub organizations that have the exact same name, and are owned by the enterprise account.

The SAML IdP and SCIM client must be configured to exactly match the displayName of the SCIM group with the name of the corresponding GitHub organization. This allows GitHub to link the SCIM group with the GitHub organization membership.

支持的 SCIM 用户属性

名称类型描述
userNamestring用户的用户名。
name.givenNamestring用户的名字
name.lastName字符串用户的姓氏。
emailsarray用户电子邮件列表。
externalId字符串此标识符由 SAML 提供程序生成，并且被 SAML 提供程序用作唯一 ID 来匹配 GitHub 用户。 You can find the externalID for a user either at the SAML provider, or using the List SCIM provisioned identities for an enterprise endpoint and filtering on other known attributes, such as a user's GitHub username or email address.
id字符串GitHub SCIM 端点生成的标识符。
activeboolean用于表示身份是处于活动状态 (true) 还是应解除预配 (false)。
groupsarrayOptional list of SCIM group IDs the user is a member of.

注：SCIM API 的端点 URL 区分大小写。 例如，Users 端点中的第一个字母必须大写：

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

Supported SCIM Group attributes

名称类型描述
displayName字符串The name of the SCIM group, which must exactly match the name of the corresponding GitHub organization. For example, if the URL of the organization is https://github.com/octo-org, the group name must be octo-org.
membersarrayList of SCIM user IDs that are members of the group.

List provisioned SCIM groups for an enterprise

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

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

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
startIndex integer query

Used for pagination: the index of the first result to return.
count integer query

Used for pagination: the number of results to return.

代码示例

Shell 
curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups
JavaScript (@octokit/core.js) 
await octokit.request('GET /scim/v2/enterprises/{enterprise}/Groups', {
  enterprise: 'enterprise'
})

Default response

Status: 200 OK
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 2,
  "itemsPerPage": 2,
  "startIndex": 1,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc",
      "externalId": null,
      "displayName": "octo-org",
      "members": [
        {
          "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
          "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
          "display": "octocat@github.com"
        },
        {
          "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5",
          "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5",
          "display": "hubot@example.com"
        }
      ],
      "meta": {
        "resourceType": "Group",
        "created": "2020-06-09T03:10:17.000+10:00",
        "lastModified": "2020-06-09T03:10:17.000+10:00",
        "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "id": "5e75bbbb-aa1a-11ea-8644-75ff655cdddd",
      "externalId": null,
      "displayName": "octo-docs-org",
      "members": [
        {
          "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
          "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
          "display": "octocat@github.com"
        }
      ],
      "meta": {
        "resourceType": "Group",
        "created": "2020-06-09T16:28:01.000+10:00",
        "lastModified": "2020-06-09T16:28:01.000+10:00",
        "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd"
      }
    }
  ]
}

Notes

Provision a SCIM enterprise group and invite users

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

Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.

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

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
schemas array of strings body

Required. The SCIM schema URIs.
displayName string body

Required. The name of the SCIM group. This must match the GitHub organization that the group maps to.
members array of objects body

undefined

Properties of the members items
value (string)

Required. The SCIM user ID for a user.

代码示例

Shell 
curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups \
  -d '{"schemas":["schemas"],"displayName":"displayName"}'
JavaScript (@octokit/core.js) 
await octokit.request('POST /scim/v2/enterprises/{enterprise}/Groups', {
  enterprise: 'enterprise',
  schemas: [
    'schemas'
  ],
  displayName: 'displayName'
})

Default response

Status: 201 Created
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc",
  "externalId": null,
  "displayName": "octo-org",
  "members": [
    {
      "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
      "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
      "display": "octocat@github.com"
    },
    {
      "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5",
      "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5",
      "display": "hubot@example.com"
    }
  ],
  "meta": {
    "resourceType": "Group",
    "created": "2020-06-09T03:10:17.000+10:0",
    "lastModified": "2020-06-09T03:10:17.000+10:00",
    "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc"
  }
}

Notes

Get SCIM provisioning information for an enterprise group

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

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

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
scim_group_id string path

Identifier generated by the GitHub SCIM endpoint.

代码示例

Shell 
curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID
JavaScript (@octokit/core.js) 
await octokit.request('GET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {
  enterprise: 'enterprise',
  scim_group_id: 'scim_group_id'
})

Default response

Status: 200 OK
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc",
  "externalId": null,
  "displayName": "octo-org",
  "members": [
    {
      "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
      "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
      "display": "octocat@github.com"
    },
    {
      "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5",
      "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5",
      "display": "hubot@example.com"
    }
  ],
  "meta": {
    "resourceType": "Group",
    "created": "2020-06-09T03:10:17.000+10:0",
    "lastModified": "2020-06-09T03:10:17.000+10:00",
    "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc"
  }
}

Notes

Set SCIM information for a provisioned enterprise group

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

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

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
scim_group_id string path

Identifier generated by the GitHub SCIM endpoint.
schemas array of strings body

Required. The SCIM schema URIs.
displayName string body

Required. The name of the SCIM group. This must match the GitHub organization that the group maps to.
members array of objects body

undefined

Properties of the members items
value (string)

Required. The SCIM user ID for a user.

代码示例

Shell 
curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \
  -d '{"schemas":["schemas"],"displayName":"displayName"}'
JavaScript (@octokit/core.js) 
await octokit.request('PUT /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {
  enterprise: 'enterprise',
  scim_group_id: 'scim_group_id',
  schemas: [
    'schemas'
  ],
  displayName: 'displayName'
})

Default response

Status: 200 OK
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc",
  "externalId": null,
  "displayName": "octo-org",
  "members": [
    {
      "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
      "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
      "display": "octocat@github.com"
    },
    {
      "value": "aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5",
      "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5",
      "display": "hubot@example.com"
    }
  ],
  "meta": {
    "resourceType": "Group",
    "created": "2020-06-09T03:10:17.000+10:0",
    "lastModified": "2020-06-09T03:10:17.000+10:00",
    "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc"
  }
}

Notes

Update an attribute for a SCIM enterprise group

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

Allows you to change 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.

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

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
scim_group_id string path

Identifier generated by the GitHub SCIM endpoint.
schemas array of strings body

Required. The SCIM schema URIs.
Operations array of objects body

Required. Array of SCIM operations.

代码示例

Shell 
curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \
  -d '{"schemas":["schemas"],"Operations":[{}]}'
JavaScript (@octokit/core.js) 
await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {
  enterprise: 'enterprise',
  scim_group_id: 'scim_group_id',
  schemas: [
    'schemas'
  ],
  Operations: [
    {}
  ]
})

Default response

Status: 200 OK
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "abcd27f8-a9aa-11ea-8221-f59b2be9cccc",
  "externalId": null,
  "displayName": "octo-org",
  "members": [
    {
      "value": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
      "$ref": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
      "display": "octocat@github.com"
    }
  ],
  "meta": {
    "resourceType": "Group",
    "created": "2020-06-09T03:10:17.000+10:00",
    "lastModified": "2020-06-09T03:10:17.000+10:00",
    "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc"
  }
}

Notes

Delete a SCIM group from an enterprise

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

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

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
scim_group_id string path

Identifier generated by the GitHub SCIM endpoint.

代码示例

Shell 
curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID
JavaScript (@octokit/core.js) 
await octokit.request('DELETE /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {
  enterprise: 'enterprise',
  scim_group_id: 'scim_group_id'
})

Default Response

Status: 204 No Content

Notes

List SCIM provisioned identities for an enterprise

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

Retrieves a paginated list of all provisioned enterprise members, including pending invitations.

When a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:

  • When a user with a SCIM-provisioned external identity is removed from an enterprise, the account's metadata is preserved to allow the user to re-join the organization in the future.
  • When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted).
  • When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO.

The returned list of external identities can include an entry for a null user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:

  1. The user is granted access by the IdP and is not a member of the GitHub enterprise.

  2. The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account.

  3. After successfully authenticating with the SAML SSO IdP, the null external identity entry is created and the user is prompted to sign in to their GitHub account:

    • If the user signs in, their GitHub account is linked to this entry.
    • If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity null entry remains in place.
get /scim/v2/enterprises/{enterprise}/Users

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
startIndex integer query

Used for pagination: the index of the first result to return.
count integer query

Used for pagination: the number of results to return.

代码示例

Shell 
curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Users
JavaScript (@octokit/core.js) 
await octokit.request('GET /scim/v2/enterprises/{enterprise}/Users', {
  enterprise: 'enterprise'
})

Default response

Status: 200 OK
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 2,
  "itemsPerPage": 2,
  "startIndex": 1,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
      "externalId": "00dowz5dr9oSfDFRA0h7",
      "userName": "octocat@github.com",
      "name": {
        "givenName": "Mona",
        "familyName": "Octocat"
      },
      "emails": [
        {
          "value": "octocat@github.com",
          "primary": true,
          "type": "work"
        }
      ],
      "groups": [
        {
          "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
        }
      ],
      "active": true,
      "meta": {
        "resourceType": "User",
        "created": "2020-05-30T04:02:34.000+10:00",
        "lastModified": "2020-05-30T04:05:04.000+10:00",
        "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5",
      "externalId": "sdfoiausdofiua",
      "userName": "hubot@example.com",
      "name": {
        "givenName": "hu",
        "familyName": "bot"
      },
      "emails": [
        {
          "value": "hubot@example.com",
          "type": "work",
          "primary": true
        }
      ],
      "groups": [],
      "active": true,
      "meta": {
        "resourceType": "User",
        "created": "2020-06-05T08:29:40.000+10:00",
        "lastModified": "2020-06-05T08:30:19.000+10:00",
        "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5"
      }
    }
  ]
}

Notes

Provision and invite a SCIM enterprise user

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

Provision enterprise membership for a user, and send organization invitation emails to the email address.

You can optionally include the groups a user will be invited to join. If you do not provide a list of groups, the user is provisioned for the enterprise, but no organization invitation emails will be sent.

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

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
schemas array of strings body

Required. The SCIM schema URIs.
userName string body

Required. The username for the user.
name object body

Required. undefined

Properties of the name object
givenName (string)

Required. The first name of the user.
familyName (string)

Required. The last name of the user.
emails array of objects body

Required. List of user emails.

Properties of the emails items
value (string)

Required. The email address.
type (string)

Required. The type of email address.
primary (boolean)

Required. Whether this email address is the primary address.
groups array of objects body

List of SCIM group IDs the user is a member of.

Properties of the groups items
value (string)

undefined

代码示例

Shell 
curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Users \
  -d '{"schemas":["schemas"],"userName":"userName","name":{"givenName":"givenName","familyName":"familyName"},"emails":["octocat@github.com"]}'
JavaScript (@octokit/core.js) 
await octokit.request('POST /scim/v2/enterprises/{enterprise}/Users', {
  enterprise: 'enterprise',
  schemas: [
    'schemas'
  ],
  userName: 'userName',
  name: {
    givenName: 'givenName',
    familyName: 'familyName'
  },
  emails: [
    'octocat@github.com'
  ]
})

Default response

Status: 201 Created
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
  "externalId": "00dowz5dr9oSfDFRA0h7",
  "userName": "mona.octocat@okta.example.com",
  "name": {
    "givenName": "Mona",
    "familyName": "Octocat"
  },
  "emails": [
    {
      "value": "mona.octocat@okta.example.com",
      "type": "work",
      "primary": true
    }
  ],
  "groups": [
    {
      "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
    }
  ],
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2017-03-09T16:11:13-05:00",
    "lastModified": "2017-03-09T16:11:13-05:00",
    "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
  }
}

Notes

Get SCIM provisioning information for an enterprise user

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

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

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
scim_user_id string path

Identifier generated by the GitHub SCIM endpoint.

代码示例

Shell 
curl \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Users/SCIM_USER_ID
JavaScript (@octokit/core.js) 
await octokit.request('GET /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}', {
  enterprise: 'enterprise',
  scim_user_id: 'scim_user_id'
})

Default response

Status: 200 OK
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
  "externalId": "00dowz5dr9oSfDFRA0h7",
  "userName": "mona.octocat@okta.example.com",
  "name": {
    "givenName": "Mona",
    "familyName": "Octocat"
  },
  "emails": [
    {
      "value": "mona.octocat@okta.example.com",
      "type": "work",
      "primary": true
    }
  ],
  "groups": [
    {
      "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
    }
  ],
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2017-03-09T16:11:13-05:00",
    "lastModified": "2017-03-09T16:11:13-05:00",
    "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
  }
}

Notes

Set SCIM information for a provisioned enterprise user

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

You must at least provide the required values for the user: userName, name, and emails.

Warning: Setting active: false removes the user from the enterprise, deletes the external identity, and deletes the associated {scim_user_id}.

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

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
scim_user_id string path

Identifier generated by the GitHub SCIM endpoint.
schemas array of strings body

Required. The SCIM schema URIs.
userName string body

Required. The username for the user.
name object body

Required. undefined

Properties of the name object
givenName (string)

Required. The first name of the user.
familyName (string)

Required. The last name of the user.
emails array of objects body

Required. List of user emails.

Properties of the emails items
value (string)

Required. The email address.
type (string)

Required. The type of email address.
primary (boolean)

Required. Whether this email address is the primary address.
groups array of objects body

List of SCIM group IDs the user is a member of.

Properties of the groups items
value (string)

undefined

代码示例

Shell 
curl \
  -X PUT \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Users/SCIM_USER_ID \
  -d '{"schemas":["schemas"],"userName":"userName","name":{"givenName":"givenName","familyName":"familyName"},"emails":["octocat@github.com"]}'
JavaScript (@octokit/core.js) 
await octokit.request('PUT /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}', {
  enterprise: 'enterprise',
  scim_user_id: 'scim_user_id',
  schemas: [
    'schemas'
  ],
  userName: 'userName',
  name: {
    givenName: 'givenName',
    familyName: 'familyName'
  },
  emails: [
    'octocat@github.com'
  ]
})

Default response

Status: 200 OK
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
  "externalId": "00dowz5dr9oSfDFRA0h7",
  "userName": "mona.octocat@okta.example.com",
  "name": {
    "givenName": "Mona",
    "familyName": "Octocat"
  },
  "emails": [
    {
      "value": "mona.octocat@okta.example.com",
      "type": "work",
      "primary": true
    }
  ],
  "groups": [
    {
      "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
    }
  ],
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2017-03-09T16:11:13-05:00",
    "lastModified": "2017-03-09T16:11:13-05:00",
    "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
  }
}

Notes

Update an attribute for a SCIM enterprise user

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

Allows you to change 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: If you set active:false using the replace operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated :scim_user_id.

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

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

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
scim_user_id string path

Identifier generated by the GitHub SCIM endpoint.
schemas array of strings body

Required. The SCIM schema URIs.
Operations array of objects body

Required. Array of SCIM operations.

代码示例

Shell 
curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Users/SCIM_USER_ID \
  -d '{"schemas":["schemas"],"Operations":[{}]}'
JavaScript (@octokit/core.js) 
await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}', {
  enterprise: 'enterprise',
  scim_user_id: 'scim_user_id',
  schemas: [
    'schemas'
  ],
  Operations: [
    {}
  ]
})

Default response

Status: 200 OK
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "92b58aaa-a1d6-11ea-8227-b9ce9e023ccc",
  "externalId": "00dowz5dr9oSfDFRA0h7",
  "userName": "mona.octocat@okta.example.com",
  "name": {
    "givenName": "Monalisa",
    "familyName": "Octocat"
  },
  "emails": [
    {
      "value": "mona.octocat@okta.example.com",
      "type": "work",
      "primary": true
    },
    {
      "value": "monalisa@octocat.github.com",
      "type": "home"
    }
  ],
  "groups": [
    {
      "value": "468dd3fa-a1d6-11ea-9031-15a1f0d7811d"
    }
  ],
  "active": true,
  "meta": {
    "resourceType": "User",
    "created": "2017-03-09T16:11:13-05:00",
    "lastModified": "2017-03-09T16:11:13-05:00",
    "location": "https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc"
  }
}

Notes

Delete a SCIM user from an enterprise

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

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

参数

Name Type In Description
accept string header

Setting to application/vnd.github.v3+json is recommended
enterprise string path

The slug version of the enterprise name. You can also substitute this value with the enterprise id.
scim_user_id string path

Identifier generated by the GitHub SCIM endpoint.

代码示例

Shell 
curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \
  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Users/SCIM_USER_ID
JavaScript (@octokit/core.js) 
await octokit.request('DELETE /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}', {
  enterprise: 'enterprise',
  scim_user_id: 'scim_user_id'
})

Default Response

Status: 204 No Content

Notes

Did this doc help you?

问问别人

找不到要找的内容？

联系我们

产品

平台

支持

公司