We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.
SCIM
REST API를 사용하여 SCIM을 사용하여 사용자 만들기 및 팀 멤버 자격을 자동화합니다.
SCIM 정보
참고: GitHub Enterprise Server에 대한 SCIM은 현재 프라이빗 베타 버전이며 변경될 수 있습니다. 베타에 액세스하려면 GitHub's Sales team에서 계정 관리자에게 문의하세요. GitHub 커뮤니티 토론에서 피드백을 제공하세요.
경고: 베타는 테스트 및 피드백 전용이며 지원을 사용할 수 없습니다. GitHub은(는) 스테이징 인스턴스를 사용하여 테스트하는 것이 좋습니다. 자세한 내용은 “스테이징 인스턴스 설정”을 참조하세요.
GitHub Enterprise Server은 SCIM 지원 ID 공급자(IdP)에서 사용할 엔드포인트를 제공합니다. IdP의 통합은 REST API를 사용하여 인증에 SAML SSO(Single Sign-On)를 사용하는 GitHub Enterprise Server 인스턴스에서 사용자 계정을 자동으로 프로비전, 관리 또는 프로비전 해제할 수 있습니다. SAML SSO에 대한 자세한 내용은 "엔터프라이즈 IAM용 SAML 정보"를 참조하세요.
이러한 엔드포인트는 SCIM 2.0을 기반으로 합니다. 자세한 내용은 사양을 참조하세요.
루트 URL
IdP는 다음 루트 URL을 사용하여 GitHub Enterprise Server 인스턴스에 대해 이 범주의 엔드포인트와 통신할 수 있습니다.
http(s)://HOSTNAME/api/v3/scim/v2/
이 범주의 엔드포인트는 대/소문자를 구분합니다. 예를 들어 엔드포인트의 첫 번째 문자는 Users
대문자로 표시되어야 합니다.
GET /scim/v2/Users/{scim_user_id}
인증
IdP의 SCIM 통합은 GitHub Enterprise Server 인스턴스에 대한 엔터프라이즈 소유자를 대신하여 작업을 수행합니다. 자세한 내용은 “엔터프라이즈의 역할”을 참조하세요.
API 요청을 인증하려면 IdP에서 SCIM을 구성하는 사람은 범위가 있는 personal access token admin:enterprise
를 사용해야 합니다. 이 범위는 IdP가 요청의 Authorization
헤더에 제공해야 합니다. personal access tokens에 대한 자세한 내용은 "personal access token 만들기"를 참조하세요.
참고: 엔터프라이즈 소유자는 이 범주의 엔드포인트에 대한 요청을 인증하기 위해 personal access token을 생성하고 사용해야 합니다. GitHub 앱 호출자는 현재 지원되지 않습니다.
SAML 및 SCIM 데이터 매핑
GitHub Enterprise Server 인스턴스는 SAML SSO를 사용하여 성공적으로 인증하는 각 사용자를 SCIM ID에 연결합니다. ID를 성공적으로 연결하려면 SAML IdP 및 SCIM 통합에서 각 사용자에 대해 일치하는 SAML NameID
및 SCIM userName
값을 사용해야 합니다.
지원되는 SCIM 사용자 특성
User
이 범주의 엔드포인트는 요청의 매개 변수 내에서 다음 특성을 지원합니다.
이름 | 형식 | Description |
---|---|---|
displayName | String | 사용자가 읽을 수 있는 사용자 이름입니다. |
name.formatted | 문자열 | 표시를 위해 서식이 지정된 모든 중간 이름, 제목 및 접미사를 포함한 사용자의 전체 이름입니다. |
name.givenName | 문자열 | 사용자의 이름입니다. |
name.familyName | 문자열 | 사용자의 성입니다. |
userName | 문자열 | IdP에서 생성한 사용자의 사용자 이름입니다. 사용되기 전에 정규화를 거칩니다. |
emails | Array | 사용자의 이메일 목록입니다. |
roles | Array | 사용자의 역할 목록입니다. |
externalId | 문자열 | 이 식별자는 IdP 공급자에 의해 생성됩니다. IdP에서 또는 SCIM 프로비전 ID 나열 엔드포인트를 사용하고 GitHub Enterprise Server 인스턴스의 사용자 이름 또는 이메일 주소와 같은 다른 알려진 특성을 필터링하여 사용자에 대한 를 찾을 externalId 수 있습니다. |
id | 문자열 | 인스턴스의 SCIM 엔드포인트에서 생성된 식별자입니다. |
active | 부울 | ID가 활성 상태인지() 일시 중단해야 하는지(true``false )를 나타냅니다. |
List provisioned SCIM groups for an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in private beta 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.
Parameters
Headers |
---|
속성, Type, Description |
accept stringSetting to |
Query parameters |
속성, Type, Description |
filter stringIf specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are |
excludedAttributes stringExcludes the specified attribute from being returned in the results. Using this parameter can speed up response time. |
startIndex integerUsed for pagination: the starting index of the first result to return when paginating through values. Default: |
count integerUsed for pagination: the number of results to return per page. Default: |
HTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/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 beta 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.
Parameters
Headers | ||||||
---|---|---|---|---|---|---|
속성, Type, Description | ||||||
accept stringSetting to | ||||||
Body parameters | ||||||
속성, Type, Description | ||||||
schemas array of stringsRequiredThe URIs that are used to indicate the namespaces of the SCIM schemas. | ||||||
externalId stringRequiredA unique identifier for the resource as defined by the provisioning client. | ||||||
displayName stringRequiredA human-readable name for a security group. | ||||||
members array of objectsRequiredThe group members. | ||||||
Properties of |
속성, Type, Description |
---|
value stringRequiredThe local unique identifier for the member |
displayName stringRequiredThe display name associated with the member |
HTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-X POST \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/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 beta and are subject to change.
Gets information about a SCIM group.
Parameters
Headers |
---|
속성, Type, Description |
accept stringSetting to |
Path parameters |
속성, Type, Description |
scim_group_id stringRequiredA unique identifier of the SCIM group. |
Query parameters |
속성, Type, Description |
excludedAttributes stringExcludes the specified attribute from being returned in the results. Using this parameter can speed up response time. |
HTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/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 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.
Parameters
Headers | ||||||
---|---|---|---|---|---|---|
속성, Type, Description | ||||||
accept stringSetting to | ||||||
Path parameters | ||||||
속성, Type, Description | ||||||
scim_group_id stringRequiredA unique identifier of the SCIM group. | ||||||
Body parameters | ||||||
속성, Type, Description | ||||||
schemas array of stringsRequiredThe URIs that are used to indicate the namespaces of the SCIM schemas. | ||||||
externalId stringRequiredA unique identifier for the resource as defined by the provisioning client. | ||||||
displayName stringRequiredA human-readable name for a security group. | ||||||
members array of objectsRequiredThe group members. | ||||||
Properties of |
속성, Type, Description |
---|
value stringRequiredThe local unique identifier for the member |
displayName stringRequiredThe display name associated with the member |
HTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-X PUT \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/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 beta 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.
Parameters
Headers | |||||||
---|---|---|---|---|---|---|---|
속성, Type, Description | |||||||
accept stringSetting to | |||||||
Path parameters | |||||||
속성, Type, Description | |||||||
scim_group_id stringRequiredA unique identifier of the SCIM group. | |||||||
Body parameters | |||||||
속성, Type, Description | |||||||
Operations array of objectsRequiredpatch operations list | |||||||
Properties of |
속성, Type, Description |
---|
op stringRequiredCan be one of: |
path string |
value stringCorresponding 'value' of that field specified by 'path' |
schemas
array of stringsRequiredHTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-X PATCH \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/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 beta and are subject to change.
Deletes a SCIM group from an enterprise.
Parameters
Headers |
---|
속성, Type, Description |
accept stringSetting to |
Path parameters |
속성, Type, Description |
scim_group_id stringRequiredA unique identifier of the SCIM group. |
HTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/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 beta 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.
You can improve query search time by using the excludedAttributes
query parameter with a value of groups
to exclude groups from the response.
Parameters
Headers |
---|
속성, Type, Description |
accept stringSetting to |
Query parameters |
속성, Type, Description |
filter stringIf specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are |
excludedAttributes stringExcludes the specified attribute from being returned in the results. Using this parameter can speed up response time. |
startIndex integerUsed for pagination: the starting index of the first result to return when paginating through values. Default: |
count integerUsed for pagination: the number of results to return per page. Default: |
HTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/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 beta 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.
Parameters
Headers | ||||||||
---|---|---|---|---|---|---|---|---|
속성, Type, Description | ||||||||
accept stringSetting to | ||||||||
Body parameters | ||||||||
속성, Type, Description | ||||||||
schemas array of stringsRequiredThe URIs that are used to indicate the namespaces of the SCIM schemas. | ||||||||
externalId stringRequiredA unique identifier for the resource as defined by the provisioning client. | ||||||||
active booleanRequiredWhether the user active in the IdP. | ||||||||
userName stringRequiredThe username for the user. | ||||||||
name object | ||||||||
Properties of |
속성, Type, Description |
---|
formatted stringThe full name, including all middle names, titles, and suffixes as appropriate, formatted for display. |
familyName stringRequiredThe family name of the user. |
givenName stringRequiredThe given name of the user. |
middleName stringThe middle name(s) of the user. |
displayName
stringRequiredA human-readable name for the user.
emails
array of objectsRequiredThe emails for the user.
Properties of emails
속성, Type, Description |
---|
value stringRequiredThe email address. |
type stringRequiredThe type of email address. |
primary booleanRequiredWhether this email address is the primary address. |
roles
array of objectsThe roles assigned to the user.
Properties of roles
속성, Type, Description |
---|
display string |
type string |
value stringRequiredThe role value representing a user role in GitHub. Can be one of: |
primary booleanIs the role a primary role for the user. |
HTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-X POST \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/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 beta and are subject to change.
Gets information about a SCIM user.
Parameters
Headers |
---|
속성, Type, Description |
accept stringSetting to |
Path parameters |
속성, Type, Description |
scim_user_id stringRequiredThe unique identifier of the SCIM user. |
HTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/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 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.
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.
Parameters
Headers | ||||||||
---|---|---|---|---|---|---|---|---|
속성, Type, Description | ||||||||
accept stringSetting to | ||||||||
Path parameters | ||||||||
속성, Type, Description | ||||||||
scim_user_id stringRequiredThe unique identifier of the SCIM user. | ||||||||
Body parameters | ||||||||
속성, Type, Description | ||||||||
schemas array of stringsRequiredThe URIs that are used to indicate the namespaces of the SCIM schemas. | ||||||||
externalId stringRequiredA unique identifier for the resource as defined by the provisioning client. | ||||||||
active booleanRequiredWhether the user active in the IdP. | ||||||||
userName stringRequiredThe username for the user. | ||||||||
name object | ||||||||
Properties of |
속성, Type, Description |
---|
formatted stringThe full name, including all middle names, titles, and suffixes as appropriate, formatted for display. |
familyName stringRequiredThe family name of the user. |
givenName stringRequiredThe given name of the user. |
middleName stringThe middle name(s) of the user. |
displayName
stringRequiredA human-readable name for the user.
emails
array of objectsRequiredThe emails for the user.
Properties of emails
속성, Type, Description |
---|
value stringRequiredThe email address. |
type stringRequiredThe type of email address. |
primary booleanRequiredWhether this email address is the primary address. |
roles
array of objectsThe roles assigned to the user.
Properties of roles
속성, Type, Description |
---|
display string |
type string |
value stringRequiredThe role value representing a user role in GitHub. Can be one of: |
primary booleanIs the role a primary role for the user. |
HTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-X PUT \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/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 beta 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
}
}]
}
Parameters
Headers | |||||||
---|---|---|---|---|---|---|---|
속성, Type, Description | |||||||
accept stringSetting to | |||||||
Path parameters | |||||||
속성, Type, Description | |||||||
scim_user_id stringRequiredThe unique identifier of the SCIM user. | |||||||
Body parameters | |||||||
속성, Type, Description | |||||||
Operations array of objectsRequiredpatch operations list | |||||||
Properties of |
속성, Type, Description |
---|
op stringRequiredCan be one of: |
path string |
value stringCorresponding 'value' of that field specified by 'path' |
schemas
array of stringsRequiredHTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-X PATCH \
-H "Accept: application/scim+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/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 beta 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.
Parameters
Headers |
---|
속성, Type, Description |
accept stringSetting to |
Path parameters |
속성, Type, Description |
scim_user_id stringRequiredThe unique identifier of the SCIM user. |
HTTP response status codes
Status code | Description |
---|---|
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 |
Code samples
curl \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/scim/v2/Users/SCIM_USER_ID
User was deleted, no content
Status: 204