TOTVS - RESTFul API


Service: /users/

O SCIM 'Users' é um protocolo de aplicação REST, para provisionamento e gerenciamento de dados de identidade na web. O protocolo suporta a criação, modificação, recuperação e descoberta de usuários.

Métodos

DELETE
/Users/{Id}

Description

Para bloquear um usuário, os clientes enviam pedidos DELETE.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

DELETE
/api/framework/v1/users/{Id}

Description

Para bloquear um usuário, os clientes enviam pedidos DELETE.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
/Users?

Description

Para recuperar um usuário conhecido, os clientes enviam requisições GET. Se o usuário existe o servidor responde com o código de estado 200 e inclui o resultado do corpo da resposta. Também é possível Listar os usuários do sistema, para tanto, basta não informar o Id do usuário.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
showadmin boolean optional
count integer optional
startindex integer optional
page integer optional
pagesize integer optional
attributes string optional
fields string optional

GET
/Users/GetUserId

Description

Retorna o id do usuário

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

GET
/Users/{userId}?

Description

Para recuperar um usuário conhecido, os clientes enviam requisições GET. Se o usuário existe o servidor responde com o código de estado 200 e inclui o resultado do corpo da resposta. Também é possível Listar os usuários do sistema, para tanto, basta não informar o Id do usuário.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
showadmin boolean optional
count integer optional
startindex integer optional
attributes string optional
fields string optional

GET
/api/framework/v1/users/{userId}?

Description

Para recuperar um usuário conhecido, os clientes enviam requisições GET. Se o usuário existe o servidor responde com o código de estado 200 e inclui o resultado do corpo da resposta. Também é possível Listar os usuários do sistema, para tanto, basta não informar o Id do usuário.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
showadmin boolean optional
count integer optional
startindex integer optional
attributes string optional
fields string optional

GET
/api/framework/v1/users?

Description

Para recuperar um usuário conhecido, os clientes enviam requisições GET. Se o usuário existe o servidor responde com o código de estado 200 e inclui o resultado do corpo da resposta. Também é possível Listar os usuários do sistema, para tanto, basta não informar o Id do usuário.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined
showadmin boolean optional
count integer optional
startindex integer optional
page integer optional
pagesize integer optional
attributes string optional
fields string optional

POST
/Users/

Description

Para criar novos usuários, os clientes enviam pedidos POST. A criação de usuário bem sucedida é indicada com um código de resposta 201 e o corpo da resposta deve conter o usuário recém-criado. Quando um usuário é criado, seu URI deve ser devolvido no HEADER Location.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

POST
/api/framework/v1/users/

Description

Para criar novos usuários, os clientes enviam pedidos POST. A criação de usuário bem sucedida é indicada com um código de resposta 201 e o corpo da resposta deve conter o usuário recém-criado. Quando um usuário é criado, seu URI deve ser devolvido no HEADER Location.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

PUT
/Users/{Id}

Description

Para atualizar usuários, os clientes enviam pedidos PUT. Para atualizar um usuário deve-se enviar todos os dados, com exceção do atributo de senha. Se o atributo de senha do usuário do usuário não for especificado, ele será mantido.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined

PUT
/api/framework/v1/users/{Id}

Description

Para atualizar usuários, os clientes enviam pedidos PUT. Para atualizar um usuário deve-se enviar todos os dados, com exceção do atributo de senha. Se o atributo de senha do usuário do usuário não for especificado, ele será mantido.

Response Content Type

Parameters

ParameterData TypeValue
_queryparam UndefinedUndefined