プロダクト概要
関連概念
curl https://scim.tencentcloudsso.com/scim/v2/ServiceProviderConfig -H "Content-type:application/json"
{"authenticationSchemes": [{"description": "Authentication scheme using the OAuth Bearer Token Standard","documentationUri": "","name": "OAuth Bearer Token","primary": true,"specUri": "","type": "oauthbearertoken"}],"bulk": {"maxOperations": 1000,"maxPayloadSize": 1048576,"supported": false},"changePassword": {"supported": false},"documentationUri": "","etag": {"supported": false},"filter": {"maxResults": 100,"supported": true},"patch": {"supported": true},"schemas": ["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],"sort": {"supported": false}}
curl https://scim.tencentcloudsso.com/scim/v2/ResourceTypes --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json"
{"Resources": [{"description": "User Account","endpoint": "/Users","id": "User","name": "User","schema": "urn:ietf:params:scim:schemas:core:2.0:User","schemaExtensions": [],"schemas": ["urn:ietf:params:scim:schemas:core:2.0:ResourceType"]},{"description": "Group","endpoint": "/Groups","id": "Group","name": "Group","schema": "urn:ietf:params:scim:schemas:core:2.0:Group","schemaExtensions": [],"schemas": ["urn:ietf:params:scim:schemas:core:2.0:ResourceType"]}],"itemsPerPage": 100,"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"startIndex": 1,"totalResults": 2}
The schema to request all resources.curl https://scim.tencentcloudsso.com/scim/v2/Schemas --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json"The schema to request users.curl https://scim.tencentcloudsso.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json"The schema to request user groups.curl https://scim.tencentcloudsso.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json"
{"attributes": [{"caseExact": false,"description": "Unique identifier for the User, typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the service provider's entire set of Users. REQUIRED.","multiValued": false,"mutability": "readWrite","name": "userName","required": true,"returned": "default","type": "string","uniqueness": "server"},{"description": "The components of the user's real name. Providers MAY return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.","multiValued": false,"mutability": "readWrite","name": "name","required": false,"returned": "default","subAttributes": [{"caseExact": false,"description": "The family name of the User, or last name in most Western languages (e.g., 'Jensen' given the full name 'Ms. Barbara J Jensen, III').","multiValued": false,"mutability": "readWrite","name": "familyName","required": false,"returned": "default","type": "string","uniqueness": "none"},{"caseExact": false,"description": "The given name of the User, or first name in most Western languages (e.g., 'Barbara' given the full name 'Ms. Barbara J Jensen, III').","multiValued": false,"mutability": "readWrite","name": "givenName","required": false,"returned": "default","type": "string","uniqueness": "none"}],"type": "complex"},{"caseExact": false,"description": "The name of the User, suitable for display to end-users. The name SHOULD be the full name of the User being described, if known.","multiValued": false,"mutability": "readWrite","name": "displayName","required": false,"returned": "default","type": "string","uniqueness": "none"},{"description": "A Boolean value indicating the User's administrative status.","multiValued": false,"mutability": "readWrite","name": "active","required": false,"returned": "default","type": "boolean"},{"description": "Email addresses for the user. The value SHOULD be canonicalized by the service provider, e.g., 'bjensen@example.com' instead of 'bjensen@EXAMPLE.COM'. Canonical type values of 'work', 'home', and 'other'.","multiValued": true,"mutability": "readWrite","name": "emails","required": false,"returned": "default","subAttributes": [{"caseExact": false,"description": "Email addresses for the user. The value SHOULD be canonicalized by the service provider, e.g., 'bjensen@example.com' instead of 'bjensen@EXAMPLE.COM'. Canonical type values of 'work', 'home', and 'other'.","multiValued": false,"mutability": "readWrite","name": "value","required": false,"returned": "default","type": "string","uniqueness": "none"},{"canonicalValues": ["work","home","other"],"caseExact": false,"description": "A label indicating the attribute's function, e.g., 'work' or 'home'.","multiValued": false,"mutability": "readWrite","name": "type","required": false,"returned": "default","type": "string","uniqueness": "none"},{"description": "A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g., the preferred mailing address or primary email address. The primary attribute value 'true' MUST appear no more than once.","multiValued": false,"mutability": "readWrite","name": "primary","required": false,"returned": "default","type": "boolean"}],"type": "complex"}],"description": "User Account","id": "urn:ietf:params:scim:schemas:core:2.0:User","name": "User","schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"]}
{"attributes": [{"caseExact": false,"description": "A human-readable name for the Group. REQUIRED.","multiValued": false,"mutability": "readWrite","name": "displayName","required": true,"returned": "default","type": "string","uniqueness": "none"},{"description": "A list of members of the Group.","multiValued": true,"mutability": "readWrite","name": "members","required": false,"returned": "default","subAttributes": [{"caseExact": false,"description": "Identifier of the member of this Group.","multiValued": false,"mutability": "immutable","name": "value","required": false,"returned": "default","type": "string","uniqueness": "none"},{"caseExact": false,"description": "A human-readable name for the group member, primarily used for display purposes.","multiValued": false,"mutability": "immutable","name": "display","required": false,"returned": "default","type": "string","uniqueness": "none"}],"type": "complex"}],"description": "Group","id": "urn:ietf:params:scim:schemas:core:2.0:Group","name": "Group","schemas": ["urn:ietf:params:scim:schemas:core:2.0:Schema"]}
curl https://scim.tencentcloudsso.com/scim/v2/Users --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X POST -d '<data>'
{"displayName": "<user display name>","emails": [{"primary": true,"type": "work","value": "<user email>"}],"name": {"familyName": "<user family name>","givenName": "<user given name>"},"userName": "<user name>"}
{"active": true,"displayName": "<user display name>","emails":[{"primary": true,"type": "work","value": "<user email>"}],"id": "u-00vrs1l19d6gbsi5****","meta":{"created": "2023-08-01T13:16:30.000Z","lastModified": "2023-08-01T13:16:30.000Z","resourceType": "User"},"name":{"familyName": "<user family name>","givenName": "<user given name>"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"userName": "<user name>"}
curl https://scim.tencentcloudsso.com/scim/v2/Users/<userId> --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X GET
{"active": true,"displayName": "<user display name>","emails":[{"primary": true,"type": "work","value": "<user email>"}],"id": "u-00vrs1l19d6gbsi5****","meta":{"created": "2023-08-01T13:16:30.000Z","lastModified": "2023-08-01T13:16:30.000Z","resourceType": "User"},"name":{"familyName": "<user family name>","givenName": "<user given name>"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"userName": "<user name>"}
curl https://scim.tencentcloudsso.com/scim/v2/Users<?parameters> --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X GET
{"Resources":[{"active": true,"displayName": "<user display name>","emails":[{"primary": true,"type": "work","value": "<user email>"}],"id": "u-0015b4962vrywtzb****","meta":{"created": "2023-07-07T17:21:07.000Z","lastModified": "2023-07-07T17:21:07.000Z","resourceType": "User"},"name":{"familyName": "<user family name>","givenName": "<user given name>"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"userName": "<user name>"},{"active": true,"displayName": "<user display name>","emails":[{"primary": true,"type": "work","value": "<user email>"}],"id": "u-00vrs1l19d6gbsi5****","meta":{"created": "2023-08-01T13:16:30.000Z","lastModified": "2023-08-01T13:16:30.000Z","resourceType": "User"},"name":{"familyName": "<user family name>","givenName": "<user given name>"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"userName": "<user name>"}],"itemsPerPage": 10,"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"startIndex": 1,"totalResults": 2}
{"Resources": [],"itemsPerPage": 10,"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"startIndex": 1,"totalResults": 0}
curl https://scim.tencentcloudsso.com/scim/v2/Users/<userId> --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X PUT -d '<data>'
{"active": false,"displayName": "<user display name>","emails":[{"primary": true,"type": "work","value": "<user email>"}],"name":{"familyName": "<user family name>","givenName": "<user given name>"},"userName": "<user name>"}
curl https://scim.tencentcloudsso.com/scim/v2/Users/<userId> --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X PATCH -d '<data>'
// replace操作{"Operations": [{"op": "replace","path": "","value": {"active": false,"displayName": "displayName","name": {"familyName": "familyName","givenName": "givenName"}}}],"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}// add操作{"Operations": [{"op": "add","path": "","value": {"displayName": "displayName","name": {"familyName": "familyName","givenName": "givenName"}}},{"op": "add","path": "active","value": true}],"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}
//replace{"active": false,"displayName": "displayName","emails":[{"primary": true,"type": "work","value": "<user email>"}],"id": "u-00vrs1l19d6gbsi5****","meta":{"created": "2023-08-01T13:16:30.000Z","lastModified": "2023-08-01T13:16:30.000Z","resourceType": "User"},"name":{"familyName": "<user family name>","givenName": "<user given name>"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"userName": "<user name>"}//add{"active": true,"displayName": "displayName","emails":[{"primary": true,"type": "work","value": "<user email>"}],"id": "u-00vrs1l19d6gbsi5****","meta":{"created": "2023-08-01T13:16:30.000Z","lastModified": "2023-08-01T13:16:30.000Z","resourceType": "User"},"name":{"familyName": "<user family name>","givenName": "<user given name>"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],"userName": "<user name>"}
curl https://scim.tencentcloudsso.com/scim/v2/Users/<userId> --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X DELETE
HTTP/1.1 204Date: Tue, 31 Mar 2020 02:36:15 GMTContent-Type: application/jsonx-RequestId: abbf9e53-9ecc-46d2-8efe-104a66ff128f
curl https://scim.tencentcloudsso.com/scim/v2/Groups --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X POST -d '<data>'
{"displayName": "<group name>","schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"]}
{"displayName": "<group name>","id": "g-00nqnd7hoevd1unv****","members": [],"meta":{"created": "2023-08-01T13:30:23.000Z","lastModified": "2023-08-01T13:30:23.000Z","resourceType": "Group"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"]}
curl https://scim.tencentcloudsso.com/scim/v2/Groups/<groupId> --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X GET
{"displayName": "<group name>","id": "g-00nqnd7hoevd1unv****","members":[{"display": "xxx","value": "u-00vrs1l19d6gbsi5****"}],"meta":{"created": "2023-08-01T13:30:23.000Z","lastModified": "2023-08-01T13:30:23.000Z","resourceType": "Group"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"]}
curl https://scim.tencentcloudsso.com/scim/v2/Groups<?parameters> --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X GET
{"Resources":[{"displayName": "<group name>","id": "g-00nqnd7hoevd1unv****","members": [],"meta":{"created": "2023-08-01T13:30:23.000Z","lastModified": "2023-08-01T13:30:23.000Z","resourceType": "Group"},"schemas":["urn:ietf:params:scim:schemas:core:2.0:Group"]}],"itemsPerPage": 10,"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"startIndex": 1,"totalResults": 1}
curl https://scim.tencentcloudsso.com/scim/v2/Groups/<groupId> --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X PUT -d '<data>'
{"displayName": "<group name>","schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"]}
curl https://scim.tencentcloudsso.com/scim/v2/Groups/<groupId> --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X PATCH -d '<data>'
//<groupId>に対応するグループから指定されたユーザー<userId>を削除する{"Operations": [{"op": "remove","path": "members","value": [{"value": "<userId>"}]}],"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}//<groupId>に対応するグループ内からすべてのユーザーを削除する{"Operations": [{"op": "remove","path": "members"}],"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}//<groupId>に対応するグループに3人のユーザーを追加する{"Operations": [{"op": "add","path": "members","value": [{"display": "<userName1>","value": "<userId1>"},{"display": "<userName2>","value": "<userId2>"},{"display": "<userName3>","value": "<userId3>"}]}],"schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]}
HTTP/1.1 204 No ContentHTTP/1.1 204Date: Tue, 07 Apr 2020 23:59:09 GMTContent-Type: application/jsonx-RequestId: dad0c91c-1ea8-4b36-9fdb-4f099b59c1c9
curl https://scim.tencentcloudsso.com/scim/v2/Groups/<groupId> --header 'Authorization: Bearer <your scim credential>' --header "content-type:application/json" -X DELETE
HTTP/1.1 204Date: Mon, 06 Apr 2020 22:21:24 GMTContent-Type: application/jsonx-RequestId: abbf9e53-9ecc-46d2-8efe-104a66ff128
フィードバック