Para: Administradores
Adicione e atualize usuários com uma chave de gerenciamento.
Liste as pessoas da sua central, adicione clientes, leia os detalhes e casos de alguém e desative ou reative o acesso dessa pessoa.
Neste artigo7 seções
Antes de começar
Esta página contém informações sobre as chamadas feitas às pessoas que fazem parte do seu hub. Os caminhos estão indicados em https://prd-api-manage.caseactive.com/v1/<hub id>. A função “Key” permite adicionar pessoas como usuários, mas apenas modifica se elas conseguem fazer login. Não é possível tornar alguém em administrador ou gerente, nem alterar os detalhes dessa pessoa após sua adição.
Chamadas
| Chamar | O que faz |
|---|---|
GET /users/relations | Lista as pessoas que estão no seu hub. |
POST /users/relations | Adiciona alguém |
GET /users/relations/<user_id> | Lê uma pessoa |
PUT /users/relations/<user_id> | Desativa ou ativa novamente alguém |
GET /users/relations/<user_id>/cases | Lista os casos em que alguém está envolvido. |
Lista de pessoas
| Parâmetro | O que faz | Obrigatório | Padrão |
|---|---|---|---|
type | 1 é destinado apenas para pessoas ativas. 0 é destinado para pessoas com deficiência. Apesar do nome, o filtro é feito com base no status da pessoa, e não no tipo de usuário. | Não | Ambos |
limit | Quantas pessoas podem estar em uma página, até 1000 pessoas. | Não | 20 |
start_key | O startKey da página anterior | Não | Primeira página |
Cada pessoa vem com… user_id, given_name, family_name, email, phone, email_verified, phone_verified, locale, zoneinfo, host_user_type (admin, manage ou user), host_user_status (1 Ativo, 0 Portadores de deficiência), host_ref_id, host_default_role, host_staff_designation, host_cases_ct (O número de casos deles) host_granted_status (approve, ou reject Assim que eles removerem o acesso do seu hub ao seu perfil… created_on. A lista não está organizada em nenhum determinado ordem. Ela inclui os seus hubs. Assistente VirtualAssistente Virtual Um membro de equipe automatizado que publica mensagens de boas-vindas, atualizações e posts de apresentação para a empresa; suas publicações exibem um selo de Assistente Virtual., de quem host_user_type É bot, E as duas pessoas que fazem parte do grupo de amostragem em cada novo hub. Uma delas é o Staff Demo. host_user_type staff. Enquanto mais pessoas ainda estiverem lá, liguem. nextLink, Ou envie startKey como start_key.
Adicionando alguém
| Campo | O que faz | Obrigatório | Padrão |
|---|---|---|---|
username | O endereço de e-mail deles, ou o número de celular, juntamente com o código do país em que se encontram, como por exemplo +12035556677. Um número sem o código do país é considerado como sendo um número dos EUA. | Sim | — |
given_name, family_name | Nome e sobrenome, mantidos em formato tipográfico. Aqueles escritos toda em letras minúsculas ou todas em letras maiúsculas são considerados palavras maiúsculas, palavra por palavra: mary smith é salvo como Mary Smith. | Sim | — |
locale | Língua: ar, de, en, es, fr, id, it, ja, pl, pt, ru ou zh | Não | en |
zoneinfo | Fuso horário, como America/New_York | Não | US/Eastern |
host_ref_id | É necessário ter um identificador próprio para eles, como um número de cliente. Esse identificador pode conter letras, números, traços e barras. Todos os caracteres devem ser escritos em minúsculas. Nenhuma duas pessoas podem compartilhar o mesmo identificador. | Não | Nenhum |
host_default_role | O papel é atribuído primeiro, quando eles são adicionados a um caso, como por exemplo role::clients. Isso não gera nenhum benefício. | Não | role::clients |
host_staff_designation | As designações habituais de seus funcionários são: primary, attorney, paralegal, case_manager, lead_attorney ou lead_paralegal. | Não | primary |
birthdate | Data de nascimento, como 1985-04-12 | Não | Nenhum |
gender | Male ou Female | Não | Nenhum |
address1, address2, locality, region, postal_code | Endereço: segunda linha, cidade, estado e CEP | Não | Nenhum |
country | Código de país de dois caracteres, como US | Não | Nenhum |
company, title | Empresa e cargo | Não | Nenhum |
host_meta_data | Os campos personalizados deles são organizados em um único objeto por página dos campos do usuário. As páginas devem ser lidas com o uso de GET /schemas?schema_type=users. Um campo marcado como Requeridos pode ser omitido: apenas a opção “Editar Usuário” precisa verificar esse campo. | Não | Nenhum |
curl -X POST https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"username": "jane.sample@example.com", "given_name": "Jane", "family_name": "Sample", "zoneinfo": "America/New_York", "host_ref_id": "cl-1042"}'
Isso responde a 201 com seus user_id.
{"data": {"host_id": "ca-7e6d5c4b3a2f10", "user_id": "cu-4f1c2a9e8b7d60", "selfLink": "https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations"}}
- Todos os usuários que são adicionados como chaves são ativos, independentemente do que você envie.
- Uma chave não pode conceder a ninguém os poderes relacionados ao portal: criar casos, adicionar pessoas aos casos ou removê-las. O envio de
host_create_case,host_add_case_userouhost_remove_case_useré recusado, e ninguém é adicionado ao portal. Um administrador é quem define quem pode acessar o portal através da chave Editar usuário. - Se o endereço ou número já tiver uma conta, seja com outra empresa ou sem nenhuma empresa, a pessoa será vinculada a essa conta. Caso contrário, será criada uma nova conta. De qualquer forma, ninguém recebe e-mails ou mensagens de texto. Eles são informados sobre você apenas quando você os adiciona a um caso, juntamente com o convite para participar do caso. Veja Como adicionar e remover membros de um caso, usando a chave de gerenciamento.
Lendo alguém
GET /users/relations/<user_id> As respostas abrangem tudo o que está na lista, além da data de nascimento, sexo, endereço, empresa e cargo deles. Também inclui campos personalizados, opções de notificação e a data da última vez em que eles acessaram o sistema. GET /users/relations/<user_id>/cases A lista contém os casos em que eles estão envolvidos, incluindo aqueles que já foram resolvidos. Para cada caso, há informações detalhadas sobre o mesmo. case_id, title, case_ref_id (O ID do seu hub, :: e o ID do tag) e case_status, E eles… case_role_id E… case_designation Estou trabalhando nisso.
Desativar ou reativar alguém
PUT /users/relations/<user_id> Leva um campo. host_user_status: 0 Para desativá-los, 1 Para reativá-los. Isso resolve o problema. 204.
curl -X PUT https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/users/relations/cu-4f1c2a9e8b7d60 \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"host_user_status": 0}'
- Uma pessoa com deficiência é recusada em todos os lugares onde quer realizar um login. No entanto, ela continua a ter seu próprio perfil no sistema, e sua conta permanece ativa para outras empresas. Veja Desativar ou reativar um usuário.
- Quando o status deles muda, eles recebem uma mensagem por e-mail ou por mensagem de texto, caso não tenham e-mail. Essas mensagens informam que o acesso deles foi desativado ou restaurado. Enviar as informações sobre o status atual deles não faz nenhuma diferença, nem traz nenhum resultado positivo.
- Uma chave pode desativar ou reativar os gestores e usuários, mas não os administradores, nem a própria chave em si.
Se uma chamada for recusada
| Status | message | Por que |
|---|---|---|
| 400 | SchemaFieldsException | O campo está ausente ou inválido. Os nomes dos campos são errors. Por exemplo, FieldUsernameTypeException pode indicar um nome de usuário que não é uma endereço de e-mail ou número de telefone. FieldPhoneTypeException pode indicar um número de telefone que não é válido. FieldNameTypeException pode indicar um nome. |
| 400 | FieldUsernameDupsException | Alguém que esteja ativo no seu hub já possui aquele endereço de e-mail ou número. reason detém o user_id dessa pessoa. |
| 400 | HostUserDisabledException | Essa pessoa está no seu hub, mas está desativada. Reativá-la, então. reason detém os user_id dela. |
| 400 | UserReferenceIdExistsException | Alguém mais já possui aquele host_ref_id. |
| 400 | HostUserTypeNotAllowedException | Você tentou desativar um administrador, ou simplesmente desativar a chave em si. |
| 403 | BotRelationFieldNotAllowedException | Você enviou energia de caso quando adicionou alguém ou qualquer outra coisa. host_user_status Ao alterá-los |
| 404 | ItemNotFoundException | Ninguém no seu hub tem esse user_id. |
Para informações sobre o corpo do erro e os demais códigos de erro, consulte Como lidar com erros da API e códigos de status.