Skip to main content
설명서에 자주 업데이트를 게시하며 이 페이지의 번역이 계속 진행 중일 수 있습니다. 최신 정보는 영어 설명서를 참조하세요.
이제 REST API의 버전이 지정됩니다. 자세한 내용은 "API 버전 관리 정보"를 참조하세요.

SCIM

REST API를 사용하여 SCIM을 사용하여 GitHub 조직 구성원 액세스를 제어하고 관리합니다.

SCIM 정보

조직의 SCIM 프로비저닝

이러한 엔드포인트는 SCIM 지원 ID 공급자(IdP)에서 GitHub Enterprise Cloud 조직 멤버 자격 프로비저닝을 자동화하는 데 사용되며 SCIM 표준 버전 2.0을 기반으로 합니다. IDP는 GitHub Enterprise Cloud SCIM 엔드포인트에 대한 기본 URL https://api.github.com/scim/v2/organizations/{org}/ 을 사용해야 합니다.

참고:

  • 이러한 엔드포인트는 SAML SSO를 사용하도록 설정된 GitHub Enterprise Cloud를 사용하는 개별 조직에서만 사용할 수 있습니다. SCIM에 대한 자세한 내용은 "조직에 대한 SCIM 정보"를 참조하세요.
  • 이러한 엔드포인트는 엔터프라이즈 계정이나 관리되는 사용자가 있는 조직에서 사용할 수 없습니다.

인증

이러한 엔드포인트를 사용하려면 GitHub Enterprise Cloud 조직의 소유자로 인증해야 합니다. REST API는 OAuth 2.0 전달자 토큰이 헤더에 Authorization 포함될 것으로 예상합니다. 인증에 personal access token (classic)를 사용하는 경우 범위가 admin:org 있어야 하며 SAML SSO 조직에서 사용할 수 있는 권한도 부여해야 합니다.

SAML 및 SCIM 데이터 매핑

SAML IdP 및 SCIM 클라이언트는 각 사용자에 대해 일치하는 NameIDuserName 값을 사용해야 합니다. 그러면 SAML을 통해 인증하는 사용자를 프로비저닝된 SCIM ID에 연결할 수 있습니다.

지원되는 SCIM 사용자 특성

Name형식설명
userNamestring사용자의 사용자 이름입니다.
name.givenNamestring사용자의 이름입니다.
name.familyNamestring사용자의 성입니다.
emailsarray사용자 메일 목록입니다.
externalIdstring이 식별자는 SAML 공급자가 생성하며, SAML 공급자에서 GitHub 사용자를 확인하기 위한 고유 ID로 사용됩니다. SCIM 프로비저닝된 ID 나열 엔드포인트를 사용하고 사용자의 GitHub 사용자 이름 또는 메일 주소와 같은 기타 알려진 특성을 필터링하거나 SAML 공급자에서 사용자의 externalID를 찾을 수 있습니다.
idstringGitHub SCIM 엔드포인트에서 생성된 식별자입니다.
activebooleanID가 활성 상태인지(true) 또는 ID 프로비전을 해제해야 하는지(false)를 나타내는 데 사용됩니다.

참고: 이러한 엔드포인트는 대/소문자를 구분합니다. 예를 들어 Users 엔드포인트의 첫 번째 문자는 대문자로 시작해야 합니다.

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

List SCIM provisioned identities

에서 작동 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 Enterprise Cloud. 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 Enterprise Cloud account after completing SSO:

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

  2. The user attempts to access the GitHub Enterprise Cloud organization and initiates the SAML SSO process, and is not currently signed in to their GitHub Enterprise Cloud 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 Enterprise Cloud account:

    • If the user signs in, their GitHub Enterprise Cloud 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 Cloud organization, and the external identity null entry remains in place.

매개 변수

헤더
이름, Type, 설명
acceptstring

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

경로 매개 변수
이름, Type, 설명
orgstring필수

The organization name. The name is not case sensitive.

쿼리 매개 변수
이름, Type, 설명
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 응답 상태 코드

상태 코드Description
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: Bearer <YOUR-TOKEN>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ 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

에서 작동 GitHub Apps

Provisions organization membership for a user, and sends an activation email to the email address. If the user was previously a member of the organization, the invitation will reinstate any former privileges that the user had. For more information about reinstating former members, see "Reinstating a former member of your organization."

매개 변수

헤더
이름, Type, 설명
acceptstring

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

경로 매개 변수
이름, Type, 설명
orgstring필수

The organization name. The name is not case sensitive.

본문 매개 변수
이름, Type, 설명
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필수
이름, Type, 설명
givenNamestring필수
familyNamestring필수
formattedstring
emailsarray of objects필수

user emails

이름, Type, 설명
valuestring필수
primaryboolean
typestring
schemasarray of strings
externalIdstring
groupsarray of strings
activeboolean

HTTP 응답 상태 코드

상태 코드Description
201

Created

304

Not modified

400

Bad request

403

Forbidden

404

Resource not found

409

Conflict

500

Internal server error

코드 샘플

post/scim/v2/organizations/{org}/Users
curl \ -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/organizations/ORG/Users \ -d '{"userName":"octocat","name":"Monalisa Octocat","emails":[{"value":"mona.octocat@github.com","primary":true}]}'

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

에서 작동 GitHub Apps

매개 변수

헤더
이름, Type, 설명
acceptstring

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

경로 매개 변수
이름, Type, 설명
orgstring필수

The organization name. The name is not case sensitive.

scim_user_idstring필수

The unique identifier of the SCIM user.

HTTP 응답 상태 코드

상태 코드Description
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: Bearer <YOUR-TOKEN>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ 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

에서 작동 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}.

매개 변수

헤더
이름, Type, 설명
acceptstring

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

경로 매개 변수
이름, Type, 설명
orgstring필수

The organization name. The name is not case sensitive.

scim_user_idstring필수

The unique identifier of the SCIM user.

본문 매개 변수
이름, Type, 설명
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필수
이름, Type, 설명
givenNamestring필수
familyNamestring필수
formattedstring
emailsarray of objects필수

user emails

이름, Type, 설명
typestring
valuestring필수
primaryboolean

HTTP 응답 상태 코드

상태 코드Description
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: Bearer <YOUR-TOKEN>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/scim/v2/organizations/ORG/Users/SCIM_USER_ID \ -d '{"userName":"octocat","name":"Monalisa Octocat","emails":[{"value":"mona.octocat@github.com","primary":true}]}'

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

에서 작동 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
    }
  }]
}

매개 변수

헤더
이름, Type, 설명
acceptstring

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

경로 매개 변수
이름, Type, 설명
orgstring필수

The organization name. The name is not case sensitive.

scim_user_idstring필수

The unique identifier of the SCIM user.

본문 매개 변수
이름, Type, 설명
schemasarray of strings
Operationsarray of objects필수

Set of operations to be performed

이름, Type, 설명
opstring필수

다음 중 하나일 수 있습니다.: add, remove, replace

pathstring
valueobject or array or string

HTTP 응답 상태 코드

상태 코드Description
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: Bearer <YOUR-TOKEN>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/scim/v2/organizations/ORG/Users/SCIM_USER_ID \ -d '{"Operations":[{"op":"replace","value":{"displayName":"Octocat"}}]}'

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

에서 작동 GitHub Apps

매개 변수

헤더
이름, Type, 설명
acceptstring

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

경로 매개 변수
이름, Type, 설명
orgstring필수

The organization name. The name is not case sensitive.

scim_user_idstring필수

The unique identifier of the SCIM user.

HTTP 응답 상태 코드

상태 코드Description
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: Bearer <YOUR-TOKEN>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/scim/v2/organizations/ORG/Users/SCIM_USER_ID

Response

Status: 204