Exemplos: Atualizar usuários com SCIM
Após criar um objeto de usuário, será possível atualizar seus campos. Para atualizar um objeto de usuário, envie uma solicitação PATCH ao ponto de extremidade Usuários.
Edições obrigatórias
| Disponível em: Salesforce Classic e Lightning Experience |
| Disponível em: Todas as edições |
Os exemplos a seguir mostram como atualizar objetos de usuário com SCIM. Estas atualizações de objeto de usuário são suportadas.
Atualizar um único campo de objeto usuário
Este exemplo mostra a atualização de um único campo no objeto de usuário.
Solicitação:
PATCH https://mycompany.my.salesforce.com/services/scim/v2/Users/<userid>
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "replace",
"value": {
"nickName": "user2"
}
}
]
}Resposta:
HTTP/1.1 200 OK
…
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "0054W00000CVREkQAP",
"userName": "scimuser@mycompany.com",
"externalId": "scimUser",
"name": {
"formatted": "User Scim",
"familyName": "Scim",
"givenName": "User"
},
"displayName": "User Scim",
"nickName": "user2",
"emails": [
{
"type": "work",
"primary": true,
"value": "user@mycompany.com"
}
],
"photos": [
{
"type": "photo",
"value": "https://mycompany.file.force.com/profilephoto/005/F"
},
{
"type": "thumbnail",
"value": "https://mycompany.file.force.com/profilephoto/005/T"
}
],
"userType": "Standard",
"preferredLanguage": "en_US",
"emailEncodingKey": "UTF-8",
"locale": "en_US",
"timezone": "America/Los_Angeles",
"active": true,
"entitlements": [
{
"value": "00e4W000002Kw0XQAS",
"$ref": "/Entitlements/00e4W000002Kw0XQAS",
"display": "System Administrator",
"type": "Profile",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"organization": "00D4W000007RdhEUAS"
},
"urn:salesforce:schemas:extension:2.0": {
"alias": "90905417"
},
"meta": {
"created": "2020-10-22T06:21:45Z",
"lastModified": "2020-10-23T05:33:53Z",
"location": "https://mycompany.my.salesforce.com/services/scim/v2/Users/0054W00000...",
"resourceType": "User",
"version": "9c7f7da0ddb5118829d51dd29e844264496f852b"
}
}
Atualizar diversos campos de objeto usuário
Este exemplo mostra a atualização de diversos campos no objeto de usuário.
Solicitação:
PATCH https://mycompany.my.salesforce.com/services/scim/v2/Users/<userid>
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "replace",
"value": [
{
"nickName": "user3",
"active": false
}
]
}
]
}Resposta:
HTTP/1.1 200 OK
…
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "0054W00000DGzivQAD",
"userName": "user3@example.com",
"name": {
"formatted": "User3 SCIM",
"familyName": "SCIM",
"givenName": "User3"
},
"displayName": "User3 SCIM",
"nickName": "user3",
"emails": [
{
"type": "work",
"primary": true,
"value": "user3@example.com"
}
],
...
"active": false,
"entitlements": [
{
"value": "00e4W000002Kw0kQAC",
"$ref": "/Entitlements/00e4W000002Kw0kQAC",
"display": "Identity User",
"type": "Profile",
"primary": true
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"organization": "00D4W000007RdhEUAS"
},
"urn:salesforce:schemas:extension:2.0": {
"alias": "11399755"
},
"meta": {
"created": "2020-11-05T09:23:19Z",
"lastModified": "2020-12-03T09:10:57Z",
"location": "https://mycompany.my.salesforce.com/services/scim/v2/Users/0054W00...",
"resourceType": "User",
"version": "18e2e5a3f4038af969c9d129c9b12f5e29c85b55"
}
}
Atualizar o papel do objeto usuário
Antes de atualizar o papel de um objeto de usuário, lembre-se de consultar o ponto de extremidade Papéis para ver uma lista de papéis disponíveis. Segue um exemplo de atualização do papel atribuído a um objeto de usuário.
Solicitação:
PATCH https://mycompany.my.salesforce.com/services/scim/v2/Users/<UserId>
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "replace",
"value": {
"roles": [
{
"value": "<role_id>"
}
]
}
}
]
}Resposta:
HTTP/1.1 200 OK
…
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "0054W00000CVREkQAP",
"userName": "scimuser@mycompany.com",
"externalId": "scimUser",
"name": {
"formatted": "User Scim",
"familyName": "Scim",
"givenName": "User"
},
"displayName": "User Scim",
"nickName": "user2",
"emails": [
{
"type": "work",
"primary": true,
"value": "user@mycompany.com"
}
...
"entitlements": [
{
"value": "00e4W000002Kw0XQAS",
"$ref": "/Entitlements/00e4W000002Kw0XQAS",
"display": "System Administrator",
"type": "Profile",
"primary": true
}
],
"roles": [
{
"value": "00E4W0000026qDpUAI",
"$ref": "/Roles/00E4W0000026qDpUAI",
"display": "CEO"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"organization": "00D4W000007RdhEUAS"
},
"urn:salesforce:schemas:extension:2.0": {
"alias": "90905417"
},
"meta": {
"created": "2020-10-22T06:21:45Z",
"lastModified": "2020-10-25T09:06:56Z",
"location": "https://mycompany.my.salesforce.com/services/scim/v2/Users/0054W000...",
"resourceType": "User",
"version": "d959e2db34c46435d2c1321126dc54ef25f2ca39"
}
}
Adicionar um conjunto de permissões a um objeto usuário
Este exemplo mostra como adicionar um conjunto de permissões a um objeto de usuário. Assim, ao editar objetos de usuário no Salesforce, é possível adicionar diversos conjuntos de permissões em objetos de usuário. Antes de adicionar um conjunto de permissões a um objeto de usuário, lembre-se de consultar o ponto de extremidade Direitos para ver uma lista de conjuntos de permissões disponíveis.
Solicitação:
PATCH https://mycompany.my.salesforce.com/services/scim/v2/Users/<UserId>
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "add",
"value": {
"entitlements": [
{
"value": "<permission_set_id>"
}
]
}
}
]
}Resposta:
HTTP/1.1 200 OK
…
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"id": "0054W00000CUpYGQA1",
"userName": "integration@00d4w000007rdheuas.com",
"name": {
"formatted": "Integration User",
"familyName": "User",
"givenName": "Integration"
},
"displayName": "Integration User",
"nickName": "integration1.4407085834085586E12",
"emails": [
{
"type": "work",
"primary": true,
"value": "integration@example.com"
}
],
"addresses": [
{
"type": "work",
"primary": true,
"country": "xx",
"formatted": "xx"
}
...
"entitlements": [
{
"value": "00e4W000002Kw0YQAS",
"$ref": "/Entitlements/00e4W000002Kw0YQAS",
"display": "Analytics Cloud Integration User",
"type": "Profile",
"primary": true
},
{
"value": "0PS4W000002pwIXWAY",
"$ref": "/Entitlements/0PS4W000002pwIXWAY",
"display": "SCIM_Test_Persmissions",
"type": "Permission Set",
"primary": false
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"organization": "00D4W000007RdhEUAS"
},
"urn:salesforce:schemas:extension:2.0": {
"alias": "integ"
},
"meta": {
"created": "2020-10-22T09:14:27Z",
"lastModified": "2020-10-26T05:58:59Z",
"location": "https://mycompany.my.salesforce.com/services/scim/v2/Users/0054W00000CUpYGQA1",
"resourceType": "User",
"version": "4cd44c006b2bc431a720b668e0acaaba32b380d1"
}
}
