Ir para o conteúdo

Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.

Atualizar a conta de usuário do dashboard

put

/scim/v2/Users/{id}

Use esse endpoint para atualizar uma conta de usuário do dashboard existente, especificando o recurso id retornado pelo método SCIM POST.

Ele permite a atualização de nomes e sobrenomes, permissões (para definir permissões no nível da empresa, do espaço de trabalho e da equipe) e departamento.

Por motivos de segurança, userName (endereço de e-mail) não pode ser atualizado por meio desse endpoint. Se quiser alterar o userName (endereço de e-mail) de um usuário, entre em contato com o Suporte.

See me in Postman

Importante

Esse endpoint exige a integração SCIM personalizada. Se você configurou uma integração de provedor de identidade (IdP) (Okta ou Entra ID), não é possível usar esse endpoint; apenas uma ponte SCIM pode ser configurada por empresa.

Pré-requisitos

Para usar esse endpoint, você precisará de um token SCIM. Você usará a origin do seu serviço como o cabeçalho X-Request-Origin. Para saber mais, consulte Provisionamento automatizado de usuários.

Limite de frequência

Esse endpoint tem um limite de frequência de 20.000 solicitações por dia, por empresa. Esse limite de frequência é compartilhado com os endpoints /scim/v2/Users/ GET, DELETE e POST, conforme documentado em Limites de frequência da API.

Parâmetros de caminho

Parâmetro	Obrigatório	Tipo de dados	Descrição
`id`	Obrigatório	String	A ID do recurso do usuário. Esse parâmetro é retornado pelos métodos `POST` `/scim/v2/Users/` ou `GET` `/scim/v2/Users?filter=userName eq "[email protected]"`.

Corpo da solicitação

Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-SCIM-TOKEN-KEY

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "name": {
        "givenName": "Test",
        "familyName": "User"
    },
    "department": "finance",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "roles": [
            {
                "roleName": "Test Role"
            },
            {
                "roleId": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd"
            }
        ],
        "appGroup": [
            {
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["view_campaigns","view_canvases"],
                "team": [
                    {
                         "teamName": "Test Team",
                         "teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
                    }
                ]
            },
            {
                "appGroupName": "Other Test Workspace",
                "appGroupPermissionSets": [
                    {
                        "appGroupPermissionSetName":  "Test Permission Set"
                    }
                ]
            }
        ]
   }
}

Parâmetros de solicitação

Parâmetro	Obrigatório	Tipo de dados	Descrição
`schemas`	Obrigatório	Matriz de strings	Nome do esquema SCIM 2.0 esperado para o objeto do usuário.
`name`	Obrigatório	Objeto JSON	Esse objeto contém o nome e o sobrenome do usuário.
`department`	Obrigatório	String	String de departamento válida da documentação de string de departamento.
`permissions`	Obrigatório	Objeto JSON	Objeto de permissões, conforme descrito na documentação do objeto de permissões.

Exemplo de solicitação

curl --location --request PUT 'https://rest.iad-01.braze.com/scim/v2/Users/dfa245b7-24195aec-887bb3ad-602b3340' \
--header 'Content-Type: application/json' \
--header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
--header 'Authorization: Bearer YOUR-SCIM-TOKEN-HERE' \
--data raw '{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "name": {
        "givenName": "Test",
        "familyName": "User"
    },
    "department": "finance",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "roles": [
            {
                "roleName": "Test Role"
            },
            {
                "roleId": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd"
            }
        ],
        "appGroup": [
            {
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["view_campaigns","view_canvases"],
                "team": [
                    {
                         "teamName": "Test Team",
                         "teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
                    }
                ]
            }
        ]
    }
}

Resposta

{
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "id": "dfa245b7-24195aec-887bb3ad-602b3340",
    "userName": "[email protected]",
    "name": {
        "givenName": "Test",
        "familyName": "User"
    },
    "department": "finance",
    "lastSignInAt": "Thursday, January 1, 1970 12:00:00 AM",
    "permissions": {
        "companyPermissions": ["manage_company_settings"],
        "roles": [
            {
                "roleName": "Test Role",
                "roleId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
                "appGroup": [
                    {
                        "appGroupId": "a1b2c3d4-e5f6-4a1b-8c2d-3e4f5a6b7c8d",
                        "appGroupName": "Some Workspace",
                        "appGroupPermissions": ["view_campaigns","view_canvases"],
                        "team": [
                            {
                                "teamId": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd",
                                "teamName": "Some Team",
                                "teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
                            }
                        ]
                    }
                ]
            },
            {
                "roleName": "Another Test Role",
                "roleId": "b2c3d4e5-f6a7-4b1c-9d2e-4f5a6b7c8d9e",
                "appGroup": [
                    {
                        "appGroupId": "c3d4e5f6-a7b8-4c1d-8e2f-5a6b7c8d9e0f",
                        "appGroupName": "Production Workspace",
                        "appGroupPermissionSets": [
                            {
                                "appGroupPermissionSetName": "A Permission Set",
                                "appGroupPermissionSetId": "d4e5f6a7-b8c9-4d1e-9f2a-6b7c8d9e0f1a",
                                "permissions": ["view_campaigns","edit_campaigns","view_content_blocks"]
                            }
                        ]
                    }
                ]
            }
        ],
        "appGroup": [
            {
                "appGroupId": "a1b2c3d4-e5f6-4a1b-8c2d-3e4f5a6b7c8d",
                "appGroupName": "Test Workspace",
                "appGroupPermissions": ["view_campaigns","view_canvases"],
                "team": [
                    {
                         "teamId": "1f16c016-8e44-48f3-9fd7-2b8d5d70d9bd",
                         "teamName": "Test Team",
                         "teamPermissions": ["edit_campaigns","launch_campaigns","edit_canvases","launch_canvases"]
                    }
                ]
            }
        ]
    }
}

Estados de erro

Se um usuário com essa ID não existir na Braze, o endpoint responderá com:

HTTP/1.1 404 Not Found
Content-Type: text/html; charset=UTF-8

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
    "detail": "User not found",
    "status": 404
}

New Stuff!