Pular para o conteúdo principal

Endpoints de Grupo

Este recurso possui endpoints relacionados à atividades que você pode fazer de gerenciamento de Grupos dentro da Plataforma StackSpot EDP.

MétodoEndpointDescriçãoParâmetrosRespostas
GET/scim/GroupsGet All GroupsX-Tenant-Id: string (header)200: OK
POST/scim/GroupsCreate GroupX-Tenant-Id: string (header), body: Create Group201: Created
GET/scim/GroupsGet All GroupsX-Tenant-Id: string (header)200: OK
POST/scim/GroupsCreate a new groupX-Tenant-Id: string (header), body: Create Group (body, required, schema: domain.CreateGroup)201: Created
GET/scim/Groups/{id}Get group by idX-Tenant-Id: string (header)200: OK
PUT/scim/Groups/{id}Update GroupsX-Tenant-Id: string (header), body: Update Group (body, required, schema: domain.UpdateGroup)200: OK
DELETE/scim/Groups/{id}Delete GroupX-Tenant-Id: string (header)204: No Content
PATCH/scim/Groups/{id}Patch Operation GroupX-Tenant-Id: string (header), body: Update Group (body, required, schema: domain.GroupPatchOperation)200: OK

Definições de Resposta

domain.CreateGroup

CampoTipoObrigatório
displayNamestringSim

domain.GroupAttributes

CampoTipoObrigatório
displayNamestringSim
membersarraySim

domain.GroupDomain

CampoTipoObrigatório
attributesobjectSim
externalIDobjectNão
idstringSim
metaobjectSim
schemasarraySim

domain.GroupPageDomain

CampoTipoObrigatório
resourcesarraySim
totalResultsintegerSim

domain.GroupPatchOperation

CampoTipoObrigatório
OperationsarraySim
schemasstringSim

domain.Meta

CampoTipoObrigatório
createdstringNão
lastModifiedstringNão
locationstringNão
resourceTypestringSim
versionstringNão

domain.PatchGroup

CampoTipoObrigatório
membersarraySim

domain.UpdateGroup

CampoTipoObrigatório
displayNamestringNão

Exemplo de resposta

GET /tenant-id/scim/Groups Get all Groups

Aqui você encontra um exemplo de resposta da API para uma chamada com o endpoint GET /tenant-id/scim/Groups Get all Groups

Requisição:

GET /tenant-id/scim/Groups Get all Groups

Header:
Authorization: Bearer token

Resposta:

Status-Code 200: {
Resources: [
{
"DisplayName": "Group Example Scim",
"description": 1,
"id": "37772f1a-6f5f-4004-b1ed-56a87d628d04",
"members": [
{
"value": "5126b021-050a-4320-9aa8-59c964e2797d",
"$ref": "/scim/Users/5126b021-050a-4320-9aa8-59c964e2797d",
"type": "User",
"display": "user.examples@stackspot.com"
}
],
"meta": {
"resourceType": "Group",
"location": "Groups/37772f1a-6f5f-4004-b1ed-56a87d628d04"
},
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:ietf:params:scim:schemas:extension:custom:2.0:Role:GroupRole",
"urn:ietf:params:scim:schemas:extension:custom:2.0:Resource:GroupResource"
],
"slug": "group-example-scim"
}
],
"itemsPerPage": 100,
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"startIndex": 1,
"totalResults": 50
}

POST /tenant-id/scim/Groups Create Group

Aqui você encontra um exemplo de resposta da API para uma chamada com o endpoint POST /tenant-id/scim/Groups Create Group

Requisição:

POST /tenant-id/scim/Groups Create Group

Header:
Authorization: Bearer token

Resposta:

Status-Code 200: {
"attributes": [],
"description": "Group Description",
"id": "5b26ee15-c6d6-4a5a-95f5-5e5d9cf10204",
"members": [],
"meta": {
"resourceType": "Group",
"created": "2024-05-31T12:52:28Z",
"lastModified": "2024-05-31T12:52:28Z",
"location": "Groups/5b26ee15-c6d6-4a5a-95f5-5e5d9cf10204"
},
"name": "Group Scim",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:ietf:params:scim:schemas:extension:custom:2.0:Role:GroupRole",
"urn:ietf:params:scim:schemas:extension:custom:2.0:Resource:GroupResource"
],
"slug": "example-slug-name",
"total": 0
}

GET /tenant-id/scim/Groups/\{id} Get Group By Id

Aqui você encontra um exemplo de resposta da API para uma chamada com o endpoint GET /tenant-id/scim/Groups/\{id} Get Group By Id.

Requisição:

GET /tenant-id/scim/Groups/\{id} Get Group By Id

Header:
Authorization: Bearer token

Resposta:

Status-Code 200: {
"attributes": [],
"description": "Group description",
"id": "5b26ee15-c6d6-4a5a-95f5-5e5d9cf10204",
"members": [],
"meta": {
"resourceType": "Group",
"created": "2024-05-31T12:52:28Z",
"lastModified": "2024-05-31T12:52:28Z",
"location": "Groups/5b26ee15-c6d6-4a5a-95f5-5e5d9cf10204"
},
"name": "Group Example Scim",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:ietf:params:scim:schemas:extension:custom:2.0:Role:GroupRole",
"urn:ietf:params:scim:schemas:extension:custom:2.0:Resource:GroupResource"
],
"slug": "example-slug-name",
"total": 0
}

PUT /tenant-id/scim/Groups/\{id} Update Group

Aqui você encontra um exemplo de resposta da API para uma chamada com o endpoint PUT /tenant-id/scim/Groups/\{id} Update Group.

Requisição:

PUT /tenant-id/scim/Groups/\{id} Update Group

Header:
Authorization: Bearer token

Resposta:

Status-Code 200: {
"attributes": [],
"description": "Test-description",
"id": "37772f1a-6f5f-4004-b1ed-56a87d628d04",
"members": [
{
"value": "5126b021-050a-4320-9aa8-59c964e2797d",
"$ref": "/scim/Users/5126b021-050a-4320-9aa8-59c964e2797d",
"type": "User",
"display": "example.user@stackspot.com"
}
],
"meta": {
"resourceType": "Group",
"created": "2024-04-24T17:59:32Z",
"lastModified": "2024-05-31T12:57:00Z",
"location": "Groups/37772f1a-6f5f-4004-b1ed-56a87d628d04"
},
"name": "Group name",
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:ietf:params:scim:schemas:extension:custom:2.0:Role:GroupRole",
"urn:ietf:params:scim:schemas:extension:custom:2.0:Resource:GroupResource"
],
"slug": "group-example-scim",
"total": 1
}

DELETE /tenant-id/scim/Groups/\{id} Remove Group

Aqui você encontra um exemplo de resposta da API para uma chamada com o endpoint DELETE /tenant-id/scim/Groups/\{id} Remove Group.

Requisição:

DELETE /tenant-id/scim/Groups/\{id} Remove Group

Header:
Authorization: Bearer token

Resposta:

Status-Code 204: NO BODY RESPONSE

PATCH /tenant-id/scim/Groups/\{id} Update Action With Patch operation

Aqui você encontra um exemplo de resposta da API para uma chamada com o endpoint PATCH /tenant-id/scim/Groups/\{id} Update Action With Patch operation.

Requisição:

PATCH /tenant-id/scim/Groups/\{id} Update Action With Patch operation

Header:
Authorization: Bearer token

Resposta:

Status-Code 200:{
"Operations": [
{
"op": "string",
"path": {
"attributePath": {
"attributeName": "string",
"subAttribute": "string",
"uriprefix": "string"
},
"subAttribute": "string",
"valueExpression": "string"
},
"value": {
"client_id": "string",
"description": "string",
"name": "string"
}
}
],
"schemas": "string"
}