Get a SCIM schema

get/scim/v2/Schemas/{schemaId}

Returns a specific SCIM schema defined on the system per RFC 7643 Section 7.

Request Samples

1

Response Samples

1{
2 "meta": {
3 "resourceType": "Schema",
4 "location": "http://localhost:8080/identities/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
5 },
6 "id": "urn:ietf:params:scim:schemas:core:2.0:Group",
7 "name": "Group",
8 "description": "Group",
9 "attributes": [
10 {
11 "name": "displayName",
12 "type": "string",
13 "multiValued": false,
14 "description": "A human-readable name for the Group. REQUIRED.",
15 "required": false,
16 "caseExact": false,
17 "mutability": "readWrite",
18 "returned": "default",
19 "uniqueness": "none"
20 },
21 {
22 "name": "members",
23 "type": "complex",
24 "multiValued": true,
25 "description": "A list of members of the Group.",
26 "required": false,
27 "caseExact": false,
28 "mutability": "readWrite",
29 "returned": "default",
30 "subAttributes": [
31 {
32 "name": "value",
33 "type": "string",
34 "multiValued": false,
35 "description": "Identifier of the member of this Group.",
36 "required": false,
37 "caseExact": false,
38 "mutability": "immutable",
39 "returned": "default",
40 "uniqueness": "none"
41 },
42 {
43 "name": "$ref",
44 "type": "reference",
45 "referenceTypes": [
46 "User",
47 "Group"
48 ],
49 "multiValued": false,
50 "description": "The URI corresponding to a SCIM resource that is a member of this Group.",
51 "required": false,
52 "caseExact": false,
53 "mutability": "immutable",
54 "returned": "default",
55 "uniqueness": "none"
56 },
57 {
58 "name": "type",
59 "type": "string",
60 "multiValued": false,
61 "description": "A label indicating the type of resource, e.g., 'User' or 'Group'.",
62 "required": false,
63 "caseExact": false,
64 "canonicalValues": [
65 "User",
66 "Group"
67 ],
68 "mutability": "immutable",
69 "returned": "default",
70 "uniqueness": "none"
71 }
72 ]
73 }
74 ]
75}

Path Parameters

NameTypeRequiredDescription
schemaId
string<uri>
true

Schema ID.

Responses

StatusMeaningDescription
200OK

The request succeeded.

Schema