The Read SCIM operation is used to get groups from Condeco based on groupId/filter.
Examples:
- Request to get group by groupID
- Request to get group by filter (display name)
- Request to get group with member
- Request to get group with page index
Read example 1
Request to get group by groupId
Request
GET "https://<CONDECO-SCIM-Domain>/scim/api/V1/groups/G602"
Response
HTTP/1.1 200 OK
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"id": "G602",
"externalId": "155fcf8c-c7a2-4145-af48-f018a10da88645",
"meta": {
"resourceType": "Group",
"created": "2021-03-09T11:52:17.777",
"location": "https://<CONDECO-SCIM-Domain>/scim/api/V1/groups/G602"
},
"displayName": "SCIMGroup"
}
Read example 2:
Request to get group by filter (display name)
Request
GET "https://<CONDECO-SCIM-Domain>/scim/api/V1/groups?filter= displayName eq "HR""
Response
HTTP/1.1 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"id": "G539",
"externalId": "Exgroup539",
"meta": {
"resourceType": "Group",
"created": "2020-07-02T07:59:25.073",
"location": "https://<CONDECO-SCIM-Domain>/scim/api/V1/groups/G539"
},
"displayName": "HR"
}
],
"totalResults": 1,
"startIndex": 1,
"itemsPerPage": 200
}
Read example 3:
Request to get group with member
Request
GET "https://<CONDECO-SCIM-Domain>/scim/api/V1/groups?filter= members eq "249"
Response
HTTP/1.1 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"id": "G57",
"externalId": "1ad5d0e9-b81e-47f1-8395-eb47ab76fa34",
"meta": {
"resourceType": "Group",
"created": "2020-07-02T07:59:25.073",
"location": "https://<CONDECO-SCIM-Domain>/scim/api/V1/groups/G57"
},
"displayName": "Integrations"
}
],
"totalResults": 1,
"startIndex": 1,
"itemsPerPage": 200
}
Read example 4:
Request to get group with page index
Request
GET "https://<CONDECO-SCIM-Domain>/scim/api/V1/groups?count=1&startIndex=2"
Response
HTTP/1.1 200 OK
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"Resources": [
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"id": "G540",
"externalId": "ExgroupAPITeam",
"meta": {
"resourceType": "Group",
"created": "2020-07-02T12:35:01.33",
"location": "https://<CONDECO-SCIM-Domain>/scim/api/V1/groups/G540"
},
"displayName": "APITeam"
}
],
"totalResults": 49,
"startIndex": 2,
"itemsPerPage": 1
}
Post your comment on this topic.