Perfis de locatário #
O recurso Perfil do Locatário permite que os perfis disponíveis sejam consultados. Os perfis de locatário controlam os recursos que serão expostos ao cliente.
/{VERSÃO}/clientes/{CUSTOMER_TENANT_ID}/tenantprofiles
Esquema de perfil de locatário #
Os perfis de locatário podem ser usados para controlar os recursos disponíveis para os clientes.
| Propriedade | Descrição | Tipo |
|---|---|---|
| id | O identificador exclusivo do perfil | corda |
| nome | O nome abreviado ao qual o perfil é referido nas UIs do portal | corda |
| descrição | Um nome descritivo mais longo para o perfil | corda |
| inadimplência | Se for verdade, esse é o perfil que será atribuído a novos clientes caso nenhum perfil de inquilino seja especificado | Bool |
| allowSelect | Indica se o perfil está disponível para uso ou se foi descontinuado para novos clientes. | Bool |
| allowChange | Indica se os clientes podem mudar para outros perfis depois que esse perfil é atribuído. | Bool |
Interfaces disponíveis #
| Interface | Descrição |
|---|---|
| Obter tudo | Retorna uma coleção de todos os perfis de locatário. |