A API "/api/framework/v1/users" do TOTVS Backoffice (Linha Protheus) permite gerenciar informações de usuários via REST com JSON, incluindo consultas, inclusão, alteração e exclusão de usuários.
Suporta filtros, paginação e detalhamento dos dados.
Dúvida
Existe alguma API para tratamento de informações do usuário?
Ambiente
Cross Segmento - TOTVS Backoffice (Linha Protheus) - ADVPL - Todas as versões.
Solução
Existe a API padronizada "/api/framework/v1/users" disponível.
Esse serviço REST permite o gerenciamento e o tratamento completo das informações de usuários cadastrados no sistema, utilizando o formato JSON para envio e retorno de dados.
Por meio dessa API, é possível realizar as operações listadas abaixo.
Consultar usuários e aplicar filtros Método: GET Endpoint: /api/framework/v1/users
Permite retornar a lista de usuários do sistema, suportando paginação e parâmetros de busca, tais como:
userId: Busca por códigos de usuários específicos (separados por vírgula).
name: Busca de usuário pelo nome.
page e pageSize: Controle de paginação da coleção de dados.
order: Ordenação dos registros retornados.
Consultar um usuário específico Método: GET Endpoint: /api/framework/v1/users/{id}
Retorna os metadados e os atributos detalhados do usuário informado (como código identificador, login de acesso, nome formatado, e-mail principal e flag de usuário ativo).
Incluir um novo usuário Método: POST Endpoint: /api/framework/v1/users
Permite cadastrar um novo usuário no sistema enviando no corpo da requisição (body) os atributos estruturados. Exemplo de requisição (POST):
{
"id": "string",
"meta": {
"resourceType": "User",
"created": "2026-07-24T17:38:54Z",
"lastModified": "2026-07-24T17:38:54Z"
},
"externalId": "string",
"name": {
"formatted": "string",
"givenName": "string",
"familyName": "string"
},
"userName": "string",
"preferredLanguage": "string",
"phoneNumbers": [
{
"value": "string",
"type": "string"
}
],
"emails": [
{
"value": "string",
"type": "string",
"primary": true
}
],
"active": true,
"groups": [
{
"value": "string",
"display": "string"
}
],
"roles": [
{
"value": "string",
"company": "string",
"action": "UpSert"
}
],
"title": "string",
"manager": [
{
"managerId": "string",
"displayName": "string"
}
],
"password": "string"
}
Alterar dados do usuário Método: PUT Endpoint: /api/framework/v1/users/{id} Realiza a atualização das informações cadastrais do usuário especificado na requisição. Exemplo de requisição (PUT):
Exemplo de Body:
{
"id": "string",
"meta": {
"resourceType": "User",
"created": "2026-07-24T17:38:54Z",
"lastModified": "2026-07-24T17:38:54Z"
},
"externalId": "string",
"name": {
"formatted": "string",
"givenName": "string",
"familyName": "string"
},
"userName": "string",
"preferredLanguage": "string",
"phoneNumbers": [
{
"value": "string",
"type": "string"
}
],
"emails": [
{
"value": "string",
"type": "string",
"primary": true
}
],
"active": true,
"groups": [
{
"value": "string",
"display": "string"
}
],
"roles": [
{
"value": "string",
"company": "string",
"action": "UpSert"
}
],
"title": "string",
"manager": [
{
"managerId": "string",
"displayName": "string"
}
]
}
Excluir usuário da base Método: DELETE Endpoint: /api/framework/v1/users/{id} Executa a exclusão ou inativação do registro do usuário correspondente na base de dados do sistema. Exemplo de retorno (DELETE):
{
"id": "string",
"meta": {
"resourceType": "User",
"created": "2026-07-24T17:38:54Z",
"lastModified": "2026-07-24T17:38:54Z"
},
"externalId": "string",
"name": {
"formatted": "string",
"givenName": "string",
"familyName": "string"
},
"userName": "string",
"preferredLanguage": "string",
"phoneNumbers": [
{
"value": "string",
"type": "string"
}
],
"emails": [
{
"value": "string",
"type": "string",
"primary": true
}
],
"active": true,
"groups": [
{
"value": "string",
"display": "string"
}
],
"roles": [
{
"value": "string",
"company": "string",
"action": "UpSert"
}
],
"title": "string",
"manager": [
{
"managerId": "string",
"displayName": "string"
}
]
}
Saiba Mais
API Reference - Usuário 1.000 Open API
/users - implementação do protocolo SCIM sobre o cadastro de usuários do Protheus.
API TOTVS padrões disponíveis
0 Comentários