Skip to main content
ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。
 

SCIM

GitHub Organizationのメンバーのアクセスを、SCIM APIを使って制御及び管理できます。

SCIM APIについて

Organization 向け SCIM プロビジョニング

SCIM API は SCIM を有効にしたアイデンティティプロバイダ (IdPs) で、GitHub Organization メンバーシップのプロビジョニングを自動化するために用いられます。 GitHub APIは、SCIM標準バージョン2に基づいています。 IdP が使用するべき GitHub SCIM エンドポイントは、https://api.github.com/scim/v2/organizations/{org}/ です。

ノート:

  • SCIM APIはSAML SSOが有効化されたGitHub Enterprise Cloudを利用する個々のOrganizationでのみ利用できます。 SCIMに関する詳しい情報については「OrganizationのためのSCIMについて」を参照してください。
  • SCIM APIはEnterpriseアカウントで、あるいはmanaged usersを持つOrganizationと合わせて使うことはできません。

SCIM API への呼び出しを認証する

SCIM API を使用するには、GitHub Organization の所有者として認証する必要があります。 API は、OAuth 2.0 Bearer トークンが Authorization ヘッダに含まれていることを想定しています。 個人アクセストークンを使用することもできますが、まず SAML SSO Organizationで使用するためにトークンを承認する必要があります。

SAML および SCIM データのマッピング

SAML IdP および SCIM クライアントは、ユーザごとに一致する NameIDuserName の値を使用する必要があります。 これにより、SAML を介して認証するユーザを、プロビジョニングされた SCIM ID にリンクできます。

サポートされている SCIM ユーザ属性

名前種類説明
userNamestringユーザのユーザ名。
name.givenNamestringユーザーの名。
name.familyNamestringユーザーの姓。
emailsarrayユーザのメール一覧。
externalIdstringこの識別子は SAML プロバイダによって生成され、GitHub ユーザと照合するためにSAML プロバイダによって一意の ID として使用されます。 ユーザの externalID は、SAML プロバイダ、または SCIM プロビジョニング済み ID の一覧表示エンドポイントを使用して、ユーザの GitHub ユーザ名やメールアドレスなどの他の既知の属性でフィルタして見つけることができます。
idstringGitHub SCIM エンドポイントによって生成された識別子。
activebooleanID がアクティブである(true)か、プロビジョニングを解除する必要がある(false)かを示すために使用する。

注釈: SCIM API のエンドポイント URL では、大文字と小文字が区別されます。 たとえば、Users エンドポイントの最初の文字は大文字にする必要があります。

GET /scim/v2/organizations/{org}/Users/{scim_user_id}

List SCIM provisioned identities

Works with GitHub Apps

Retrieves a paginated list of all provisioned organization members, including pending invitations. If you provide the filter parameter, the resources for all matching provisions members are returned.

When a user with a SAML-provisioned external identity leaves (or is removed from) an organization, 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 organization, 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 organization.

  2. The user attempts to access the GitHub organization 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 organization, and the external identity null entry remains in place.

パラメータ

Headers
名前, 種類, 説明
acceptstring

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

Path parameters
名前, 種類, 説明
orgstring必須

The organization name. The name is not case sensitive.

クエリパラメータ
名前, 種類, 説明
startIndexinteger

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

countinteger

Used for pagination: the number of results to return.

filterstring

Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query:

?filter=userName%20eq%20\"Octocat\".

To filter results for the identity with the email octocat@github.com, you would use this query:

?filter=emails%20eq%20\"octocat@github.com\".

HTTP response status codes

Status code説明
200

OK

304

Not modified

400

Bad Request

403

Forbidden

404

Resource not found

429

Too Many Requests

コードサンプル

get/scim/v2/organizations/{org}/Users
curl \ -H "Accept: application/scim+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/scim/v2/organizations/ORG/Users

Response with filter

Status: 200
{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ], "totalResults": 1, "itemsPerPage": 1, "startIndex": 1, "Resources": [ { "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "5fc0c238-1112-11e8-8e45-920c87bdbd75", "externalId": "00u1dhhb1fkIGP7RL1d8", "userName": "octocat@github.com", "displayName": "Mona Octocat", "name": { "givenName": "Mona", "familyName": "Octocat", "formatted": "Mona Octocat" }, "emails": [ { "value": "octocat@github.com", "primary": true } ], "active": true, "meta": { "resourceType": "User", "created": "2018-02-13T15:05:24.000-08:00", "lastModified": "2018-02-13T15:05:55.000-08:00", "location": "https://api.github.com/scim/v2/organizations/octo-org/Users/5fc0c238-1112-11e8-8e45-920c87bdbd75" } } ] }

Provision and invite a SCIM user

Works with GitHub Apps

Provision organization membership for a user, and send an activation email to the email address.

パラメータ

Headers
名前, 種類, 説明
acceptstring

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

Path parameters
名前, 種類, 説明
orgstring必須

The organization name. The name is not case sensitive.

Body parameters
名前, 種類, 説明
userNamestring必須

Configured by the admin. Could be an email, login, or username

displayNamestring

The name of the user, suitable for display to end-users

nameobject必須
名前, 種類, 説明
givenNamestring必須
familyNamestring必須
formattedstring
emailsarray of objects必須

user emails

名前, 種類, 説明
valuestring必須
primaryboolean
typestring
schemasarray of strings
externalIdstring
groupsarray of strings
activeboolean

HTTP response status codes

Status code説明
201

Created

304

Not modified

400

Bad Request

403

Forbidden

404

Resource not found

409

Conflict

500

Internal Error

コードサンプル

post/scim/v2/organizations/{org}/Users
curl \ -X POST \ -H "Accept: application/scim+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/scim/v2/organizations/ORG/Users

Response

Status: 201
{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "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/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } }

Get SCIM provisioning information for a user

Works with GitHub Apps

パラメータ

Headers
名前, 種類, 説明
acceptstring

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

Path parameters
名前, 種類, 説明
orgstring必須

The organization name. The name is not case sensitive.

scim_user_idstring必須

The unique identifier of the SCIM user.

HTTP response status codes

Status code説明
200

OK

304

Not modified

403

Forbidden

404

Resource not found

コードサンプル

get/scim/v2/organizations/{org}/Users/{scim_user_id}
curl \ -H "Accept: application/scim+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/scim/v2/organizations/ORG/Users/SCIM_USER_ID

Response

Status: 200
{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "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/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } }

Update a provisioned organization membership

Works with GitHub Apps

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 organization, deletes the external identity, and deletes the associated {scim_user_id}.

パラメータ

Headers
名前, 種類, 説明
acceptstring

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

Path parameters
名前, 種類, 説明
orgstring必須

The organization name. The name is not case sensitive.

scim_user_idstring必須

The unique identifier of the SCIM user.

Body parameters
名前, 種類, 説明
schemasarray of strings
displayNamestring

The name of the user, suitable for display to end-users

externalIdstring
groupsarray of strings
activeboolean
userNamestring必須

Configured by the admin. Could be an email, login, or username

nameobject必須
名前, 種類, 説明
givenNamestring必須
familyNamestring必須
formattedstring
emailsarray of objects必須

user emails

名前, 種類, 説明
typestring
valuestring必須
primaryboolean

HTTP response status codes

Status code説明
200

OK

304

Not modified

403

Forbidden

404

Resource not found

コードサンプル

put/scim/v2/organizations/{org}/Users/{scim_user_id}
curl \ -X PUT \ -H "Accept: application/scim+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/scim/v2/organizations/ORG/Users/SCIM_USER_ID

Response

Status: 200
{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "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/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } }

Update an attribute for a SCIM user

Works with GitHub Apps

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 organization, deletes the external identity, and deletes the associated :scim_user_id.

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

パラメータ

Headers
名前, 種類, 説明
acceptstring

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

Path parameters
名前, 種類, 説明
orgstring必須

The organization name. The name is not case sensitive.

scim_user_idstring必須

The unique identifier of the SCIM user.

Body parameters
名前, 種類, 説明
schemasarray of strings
Operationsarray of objects必須

Set of operations to be performed

名前, 種類, 説明
opstring必須

Can be one of: add, remove, replace

pathstring
valueobject or array or string

HTTP response status codes

Status code説明
200

OK

304

Not modified

400

Bad Request

403

Forbidden

404

Resource not found

429

Too Many Requests

コードサンプル

patch/scim/v2/organizations/{org}/Users/{scim_user_id}
curl \ -X PATCH \ -H "Accept: application/scim+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/scim/v2/organizations/ORG/Users/SCIM_USER_ID

Response

Status: 200
{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "id": "edefdfedf-050c-11e7-8d32", "externalId": "a7d0f98382", "userName": "mona.octocat@okta.example.com", "displayName": "Monalisa Octocat", "name": { "givenName": "Monalisa", "familyName": "Octocat", "formatted": "Monalisa Octocat" }, "emails": [ { "value": "mona.octocat@okta.example.com", "primary": true }, { "value": "monalisa@octocat.github.com" } ], "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/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32" } }

Delete a SCIM user from an organization

Works with GitHub Apps

パラメータ

Headers
名前, 種類, 説明
acceptstring

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

Path parameters
名前, 種類, 説明
orgstring必須

The organization name. The name is not case sensitive.

scim_user_idstring必須

The unique identifier of the SCIM user.

HTTP response status codes

Status code説明
204

No Content

304

Not modified

403

Forbidden

404

Resource not found

コードサンプル

delete/scim/v2/organizations/{org}/Users/{scim_user_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/scim/v2/organizations/ORG/Users/SCIM_USER_ID

Response

Status: 204