Requisição
Para modificar informações sobre Usuários, faça uma solicitação ao seguinte endpoint:
PATCH /scim/v2/Users:id
Parâmetros
| Nome | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
userName |
String | Obrigatório | O identificador de login exclusivo do usuário. | "dschrute" |
externalId |
String | Obrigatório | Um identificador externo para o usuário. | "12345" |
name.formatted |
String | Obrigatório | Nome completo do usuário. | "Dwight Schrute" |
name.familyName |
String | Opcional | O sobrenome do usuário. | "Schrute" |
name.givenName |
String | Opcional | O nome próprio do usuário. | "Dwight" |
phoneNumbers.value |
String | Opcional | O número de telefone do usuário. | "+1 (555) 123-4567" |
emails.value |
String | Obrigatório | Endereço de email do usuário. | "[email protected]" |
emails.type |
String | Opcional | A categoria do endereço de e-mail. | "trabalho" |
emails.primary |
Boolean | Opcional | Indica se o endereço de email é o email principal do usuário. | true |
entitlements |
String | Opcional | O papel do usuário no sistema. | "Gerente Regional Assistente" |
groups.value |
String | Opcional | Os grupos de usuários associados ao usuário. | "Vendas" |
Attention
Ao integrar com o Microsoft Entra, o atributo entitlements pode ser preenchido dinamicamente por meio de uma expressão.
Nesse caso, o mapeamento deve ser configurado da seguinte forma:
- Tipo de mapeamento:
Expression - Expressão:
AssertiveAppRoleAssignmentsComplex([appRoleAssignments]) - Atributo de destino:
entitlements - Aplicar este mapeamento:
Always
Essa configuração garante que as atribuições de função (roles) definidas no Entra sejam corretamente associadas ao atributo entitlements no SCIM.
Retorno
Retorna as informações atualizadas associadas aos usuários.
Exemplo de resposta
HTTP/1.1 200 OK
{
"schemas":["urn:ietf:params:scim:schemas:core:2.0:User"],
"id":"2819c223-7f76-453a-919d-413861904646",
"externalId":"dschrute",
"meta":{
"resourceType":"User",
"created":"2011-08-01T21:32:44.882Z",
"lastModified":"2011-08-01T21:32:44.882Z",
"location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
"version":"W\/\"e180ee84f0671b1\""
},
"name":{
"familyName":"Schrute",
"givenName":"Dwight"
},
"userName":"dschrute"
}