Editar usuário

put

{protocol}://{host}/service/admin/api/v5/users/{userId}

Realiza envio de requisição para edição de usuários.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

O que precisa saber antes de usar este serviço?

Se você ainda não viu, acesse a documentação de negócios: Editar usuário

Path Params

userId

integer

required

Deve ser informado o código do usuário que será alterado.

Body Params

Deve ser informado um ou mais campos e seus valores em formato json (application/json) na declaração na estrutura do body.

string

required

length ≤ 255

Deve ser informado e-mail para o cadastro do usuário.

name

string

required

length ≤ 50

Deve ser informado o nome do usuário referente ao cadastro do usuário.

idLeader

integer

Deve ser informado o código do líder para o cadastro do usuário. Quando não informado, o próprio usuário será configurado configurado como líder.

idDepartment

integer

required

Deve ser informado o código do departamento para o cadastro do usuário e seu tipo deve ser “integer”.

searchAccess

string

enum

required

Defaults to C

Deve ser informado o valor referente ao tipo de pesquisa de processos permitido para o usuário do módulo workspace.
C = com permissão completa de pesquisa de processos
P = com permissão parcial de pesquisas de processos
N = sem permissão de pesquisas de processos

Allowed:

language

string

enum

required

Defaults to pt_BR

Deve ser informado o idioma para o cadastro do usuário.
pt_BR (Português Brasil)
en_US (English)
es_ES (Espanhol)

Allowed:

cellphone

string

length ≤ 255

Dever ser informado o número do celular para o cadastro de usuário.

city

string

length ≤ 255

Deve ser informada a cidade para o cadastro do usuário.

idSubstitute

integer

Deve ser informado o código do usuário substituto para o cadastro do usuário.

zipcode

string

length ≤ 255

Deve ser informado o código postal (CEP) para o cadastro do usuário.

complement

string

length ≤ 255

Deve ser informado o complemento do endereço para o cadastro do usuário.

endDateVacation

date

length between 0 and 10

Deve ser informada a data final das férias do usuário para o cadastro de usuário. O valor deve seguir o padrão yyyy-MM-dd.

startDateVacation

date

length between 0 and 10

Deve ser informada a data inicial das férias do usuário para o cadastro de usuário. O valor deve seguir o padrão yyyy-MM-dd.

information1

string

length ≤ 50

Deve ser informado para armazenar informações adicionais para o usuário.

information2

string

length ≤ 50

Deve ser informado para armazenar informações adicionais para o usuário.

information3

string

length ≤ 50

Deve ser informado para armazenar informações adicionais para o usuário

expiredPassword

boolean

Deve ser informado para expirar a senha atual do usuário para que seja trocada no próximo login de acesso do ambiente. (True ou False)

administratorAccess

boolean

Deve ser informado o valor referente para usuário ter permissão administrativo para o ambiente.
true = com permissão de acesso Administrativo
false = sem permissão de acesso Administrativo

statisticsAccess

boolean

Deve ser informado o valor referente para que o usuário possa ter acesso a opção Estatísticas do módulo Análises do ambiente.
true = com permissão de acesso a Estatísticas
false = sem permissão de acesso a Estatísticas

externalAccess

boolean

Deve ser informado o valor referente para que o usuário seja configurado como externo e só possa acessar as informações de processos que ele fará parte.
true = com propriedade usuário externo
false = sem propriedade usuário externo

chartAccess

boolean

Deve ser informado o valor referente para que o usuário tenha permissão para criar e utilizar gráficos personalizados no módulo análises.
true = com permissão a gráficos personalizados
false = sem permissão a gráficos personalizados

processChangePermission

boolean

Deve ser informado o valor referente para que o usuário tenha permissão de alteração de processo no módulo Studio.
true = com permissão para alterar processos no módulo Studio
false = sem permissão para alterar processos no módulo Studio.
Obs. Essa configuração dependerá da configuração processCreatePermission, caso usuário tenha permissão de criação essa configuração será colocada automaticamente como true, ignorando o que for enviado na requisição.

delayedProcessPanelAccess

boolean

Deve ser informado o valor referente para que o usuário tenha acesso ao Painel de atraso de processo do módulo análises.
true = com permissão a opção Painel de Atrasos em Análises
false = sem permissão a opção Painel de Atrasos em Análises

userProfileChangePermission

boolean

Deve ser informado o valor referente para que o usuário tenha permissão da configuração de perfil do usuário no módulo workspace.
true = com permissão para configuração de perfil
false = sem permissão para configuração de perfil

authenticationType

string

enum

Deve ser informado o valor referente ao tipo de autenticação para que o usuário tenha o acesso ao ambiente pelo tipo de autenticação desejado.
SSO = Acesso de usuário a partir do SSO Lecom
LDAP = Acesso de usuário a partir do AD/LDAP
SAML = Acesso de usuário a partir do SAML
OAUTH = Acesso de usuário a partir do OAUTH

Allowed:

specialFieldAccess

boolean

Deve ser informado o valor referente para que usuário possa ter permissão a campo com restrição de acesso de processos do ambiente.
true = usuário com acesso a campos com restrição de acesso nos processos
false = usuário sem acesso a campos com restrição de acesso nos processos

delayActivityGraphAccess

boolean

Deve ser informado o valor referente para o usuário ter permissão a gráfico de atividades em atraso no módulo Análises do ambiente
true = usuário com acesso a gráfico de atividades em atraso no módulo Análises
false = usuário sem acesso a gráfico de atividades em atraso no módulo Análises

delayProcessGraphAcess

boolean

Deve ser informado o valor referente para o usuário ter permissão a gráfico de processos em atraso no módulo Análises do ambiente
true = usuário com acesso a gráfico de processos em atraso no módulo Análises
false = usuário sem acesso a gráfico de processos em atraso no módulo Análises

openedProcessesGraphAccess

boolean

Deve ser informado o valor referente para que usuário possa utilizar gráficos de processos abertos por status no módulo Análises do ambiente.
true = usuário com acesso aos gráficos de processos aberto por status no módulo Análises.
false = usuário sem acesso aos gráficos de processos aberto por status no módulo Análises.

openedProcessesGraphAccessInTest

boolean

Deve ser informado o valor referente para que usuário possa utilizar gráficos de processos abertos por status em modo teste no módulo Análises do ambiente.
true = usuário com acesso aos gráficos de processos aberto por status em modo teste no módulo Análises
false = usuário sem acesso aos gráficos de processos aberto por status em modo teste no módulo Análises

openedProcessesRelationGraphAccess

boolean

Deve ser informado o valor referente para que usuário possa utilizar gráficos de processos abertos por status em modo teste no módulo Análises do ambiente.
true = usuário com acesso ao gráfico de relação de processos aberto por status no módulo Análises
false = usuário sem acesso ao gráfico de relação de processos aberto por status no módulo Análises

userStatusGraphAccess

boolean

Deve ser informado o valor referente para que usuário possa utilizar gráfico de usuários por status no módulo Análises do ambiente.
true = usuário com acesso ao gráfico de relação de processos aberto por status no módulo Análises
false = usuário sem acesso ao gráfico de relação de processos aberto por status no módulo Análises

myChartsAccess

boolean

Deve ser informado o valor referente para informar se usuário tem permissão de abrir gráficos personalizados em “Meus Gráficos”.
true = usuário tem permissão de abrir gráficos personalizados em “Meus Gráficos”.
false = usuário não tem permissão de abrir gráficos personalizados em “Meus Gráficos”.

inactivatedUser

boolean

Deve ser informado o valor referente para informar se usuário apresenta inativo no ambiente.
true = usuário inativo no ambiente.
false = usuário ativo no ambiente.

address

string

length ≤ 255

Deve ser informado o logradouro referente ao endereço do cadastro do usuário.

number

string

length ≤ 255

Deve ser informado o número do logradouro do usuário referente ao cadastro do usuário.

telephone

string

length ≤ 255

Deve ser informado o telefone do usuário referente ao cadastro do usuário.

state

string

length ≤ 255

Deve ser informado o estado (Unidade Federativa) do usuário referente ao cadastro do usuário.

aliasId

integer

Deve ser informado o código do Alias que o usuário está vinculado. Usado somente quanto a licença do ambiente é por quantidade de usuários.

processCreatePermission

boolean

Deve ser informado o valor referente para que o usuário tenha permissão de criaçãode processo no módulo Studio.
true = usuário com permissão para criar processos no módulo Studio.
false = usuário com permissão para criar processos no módulo Studio.
Obs. Apenas usuários master podem manipular essa permissão. Caso usuário da requisição não for master, o serviço irá ignorar a configuração enviada na requisição.

administratorECMAccess

boolean

Deve ser informado o valor referente para que o usuário tenha permissão administrador no Módulo Documentos.
true = Com permissão como administrador do módulo Documentos
false = Sem permissão como administrador do módulo Documentos

digitalSignature

boolean

Deve ser informado o valor referente para que o usuário tenha permissão à assinatura digital no Módulo Documentos.
true = Com permissão à Assinatura Digital no módulo Documentos
false = Sem permissão à Assinatura Digital no módulo Documentos

createFolders

boolean

Deve ser informado o valor referente para que o usuário tenha permissão à criação de pastas no Módulo Documentos.
true = Com permissão à criação de pastas no módulo Documentos
false = Sem permissão à criação de pastas no módulo Documentos

turnFoldersPublic

boolean

Deve ser informado o valor referente para que o usuário tenha permissão à tornar as pastas no Módulo Documentos públicas.
true = Com permissão à tornar as pastas no Módulo Documentos públicas
false = Sem permissão à tornar as pastas no Módulo Documentos públicas

password

string

length ≤ 40

Deve ser informada a nova senha de acesso do ambiente para o cadastro do usuário. Quando a senha não for informada, a senha atual não será alterada.

blocked

boolean

Deve ser informado o valor referente para que o usuário seja criado como bloqueado.
true = Usuário bloqueado
false = Usuário desbloqueado

mfaEnabled

boolean

Deve ser informado se o usuário está com multiplo fator de autenticação habilitado.
true = multiplo fator de autenticação habilitado
false = multiplo fator de autenticação desabilitado

forwardActivities

boolean

Permite ao usuário da chave apikey do OPENAPI realizar o consumo dos serviços: Encaminhar atividades, Incluir responsável em uma atividade e Remover responsável em uma atividade

removeHibernation

boolean

Permite ao usuário da chave apykey do OPENAPI realizar o consumo do serviço: Remover uma atividade da hibernação

changeSLA

boolean

Permite o usuário da chave apykey do OPENAPI realizar o consumo dos serviços: Alterar prazos (SLA) de uma atividade e Calcular o tempo útil para cálculo de prazos da atividade

cancelProcesses

boolean

Permite ao usuário da chave apykey do OPENAPI realizar o consumo do serviço: Cancelar um processo

Headers

X-Server

string

required

Deve ser informado o domínio do ambiente onde será retornada as informações do usuário criado

Response

O que precisa saber antes de usar este serviço?

200Estrutura de recebimento dos valores após execução da requisição de consulta.