Table of Contents
Objeto de diretório de usuário
Os seguintes objetos estão diretamente relacionados à API userdirectory.
Diretório de usuários
O objeto de diretório de usuários possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| userdirectoryid | ID | ID do diretório de usuários. Se um diretório de usuários for excluído, o valor da propriedade userdirectoryid do objeto Usuário será definido como "0" para todos os usuários vinculados ao diretório de usuários excluído.Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| idp_type | integer | Tipo de protocolo de autenticação usado pelo provedor de identidade para o diretório de usuários. Observe que só pode existir um diretório de usuários do tipo SAML. Valores possíveis: 1 - Diretório de usuários do tipo LDAP; 2 - Diretório de usuários do tipo SAML. Comportamento da propriedade: - obrigatório para operações de criação |
| group_name | string | Atributo do diretório de usuários LDAP/SAML que contém o nome do grupo usado para mapear grupos entre o diretório de usuários LDAP/SAML e o Zabbix. Exemplo: cn Comportamento da propriedade: - obrigatório se provision_status estiver definido como "Habilitado" e saml_jit_status do objeto Autenticação estiver definido como "Habilitado para IdPs SAML configurados" |
| user_username | string | Atributo do diretório de usuários LDAP/SAML (também atributo SCIM se scim_status estiver definido como "Provisionamento SCIM habilitado") que contém o nome do usuário que é usado como valor para a propriedade name do objeto Usuário quando o usuário é provisionado.Exemplos: cn, commonName, displayName, name |
| user_lastname | string | Atributo do diretório de usuários LDAP/SAML (também atributo SCIM se scim_status estiver definido como "Provisionamento SCIM habilitado") que contém o sobrenome do usuário que é usado como valor para a propriedade surname do objeto Usuário quando o usuário é provisionado.Exemplos: sn, surname, lastName |
| provision_status | integer | Status de provisionamento do diretório de usuários. Valores possíveis: 0 - (padrão) Desabilitado (o provisionamento de usuários criados por este diretório de usuários está desabilitado); 1 - Habilitado (o provisionamento de usuários criados por este diretório de usuários está habilitado; adicionalmente, o status do provisionamento LDAP ou SAML ( ldap_jit_status ou saml_jit_status do objeto Autenticação) deve estar habilitado). |
| provision_groups | array | Array de objetos de mapeamentos de grupos de provisionamento para mapear o padrão de grupo do diretório de usuários LDAP/SAML para o grupo de usuários e função de usuário do Zabbix. Comportamento da propriedade: - obrigatório se provision_status estiver definido como "Habilitado" |
| provision_media | array | Array de objetos de mapeamentos de tipos de mídia para mapear atributos de mídia do usuário LDAP/SAML (por exemplo, e-mail) para mídia de usuário do Zabbix para envio de notificações. |
| Propriedades específicas do LDAP: | ||
| name | string | Nome exclusivo do diretório de usuários. Comportamento da propriedade: - obrigatório se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| host | string | Nome do host, IP ou URI do servidor LDAP. A URI deve conter o esquema ( ldap:// ou ldaps://), host e porta (opcional).Exemplos: host.example.com 127.0.0.1 ldap://ldap.example.com:389 Comportamento da propriedade: - obrigatório se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| port | integer | Porta do servidor LDAP. Comportamento da propriedade: - obrigatório se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| base_dn | string | Caminho base do diretório de usuários LDAP para contas de usuário. Exemplos: ou=Users,dc=example,dc=org ou=Users,ou=system (para OpenLDAP) DC=company,DC=com (para Microsoft Active Directory) uid=%{user},dc=example,dc=com (para vinculação direta de usuário; o placeholder "%{user}" é obrigatório) Comportamento da propriedade: - obrigatório se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| search_attribute | string | Atributo do diretório de usuários LDAP pelo qual identificar a conta de usuário a partir das informações fornecidas na solicitação de login. Exemplos: uid (para OpenLDAP) sAMAccountName (para Microsoft Active Directory) Comportamento da propriedade: - obrigatório se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| bind_dn | string | Conta do servidor LDAP para vinculação e pesquisa no servidor LDAP. Para vinculação direta de usuário e vinculação anônima, bind_dn deve estar vazio.Exemplos: uid=ldap_search,ou=system (para OpenLDAP) CN=ldap_search,OU=user_group,DC=company,DC=com (para Microsoft Active Directory) CN=Admin,OU=Users,OU=Zabbix,DC=zbx,DC=local Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| bind_password | string | Senha LDAP da conta para vinculação e pesquisa no servidor LDAP. Para vinculação direta de usuário e vinculação anônima, bind_password deve estar vazio.Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| description | string | Descrição do diretório de usuários. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| group_basedn | string | Caminho base do diretório de usuários LDAP para grupos; usado para configurar uma verificação de associação de usuário no diretório de usuários LDAP. Ignorado ao provisionar um usuário se group_membership estiver definido.Exemplo: ou=Groups,dc=example,dc=com Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| group_filter | string | String de filtro para recuperar grupos do diretório de usuários LDAP dos quais o usuário é membro; usado para configurar uma verificação de associação de usuário no diretório de usuários LDAP. Ignorado ao provisionar um usuário se group_membership estiver definido.Placeholders suportados em group_filter:%{attr} - atributo de pesquisa (substituído pelo valor da propriedade search_attribute);%{groupattr} - atributo de grupo (substituído pelo valor da propriedade group_member);%{host} - nome do host, IP ou URI do servidor LDAP (substituído pelo valor da propriedade host);%{user} - nome de usuário do Zabbix. Padrão: (%{groupattr}=%{user}) Exemplos: - (member=uid=%{ref},ou=Users,dc=example,dc=com) corresponderá a "User1" se um objeto de grupo LDAP contiver o atributo "member" com o valor "uid=User1,ou=Users,dc=example,dc=com", e retornará o grupo do qual "User1" é membro; - (%{groupattr}=cn=%{ref},ou=Users,ou=Zabbix,DC=example,DC=com) corresponderá a "User1" se um objeto de grupo LDAP contiver o atributo especificado na propriedade group_member com o valor "cn=User1,ou=Users,ou=Zabbix,DC=example,DC=com", e retornará o grupo do qual "User1" é membro.Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| group_member | string | Atributo do diretório de usuários LDAP que contém informações sobre os membros do grupo; usado para configurar uma verificação de associação de usuário no diretório de usuários LDAP. Ignorado ao provisionar um usuário se group_membership estiver definido.Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| group_membership | string | Atributo do diretório de usuários LDAP que contém informações sobre os grupos aos quais um usuário pertence. Exemplo: memberOf Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| search_filter | string | String de filtro personalizado usada para localizar e autenticar um usuário em um diretório de usuários LDAP com base nas informações fornecidas na solicitação de login. Placeholders suportados em search_filter:%{attr} - nome do atributo de pesquisa (por exemplo, uid, sAMAccountName); %{user} - nome de usuário do Zabbix. Padrão: (%{attr}=%{user}) Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| start_tls | integer | Opção de configuração do servidor LDAP que permite que a comunicação com o servidor LDAP seja protegida usando Transport Layer Security (TLS). Observe que start_tls deve ser definido como "Desabilitado" para hosts usando o protocolo ldaps://.Valores possíveis: 0 - (padrão) Desabilitado; 1 - Habilitado. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| user_ref_attr | string | Atributo do diretório de usuários LDAP usado para referenciar um objeto de usuário. O valor de user_ref_attr é usado para obter valores do atributo especificado no diretório de usuários e colocá-los no lugar do placeholder %{ref} na string group_filter.Exemplos: cn, uid, member, uniqueMember Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo LDAP" |
| Propriedades específicas do SAML: | ||
| idp_entityid | string | URI que identifica o provedor de identidade e é usada para se comunicar com o provedor de identidade em mensagens SAML. Exemplo: https://idp.example.com/idp Comportamento da propriedade: - obrigatório se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| sp_entityid | string | URL ou qualquer string que identifica o provedor de serviços do provedor de identidade. Exemplos: https://idp.example.com/sp zabbix Comportamento da propriedade: - obrigatório se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| username_attribute | string | Atributo do diretório de usuários SAML (também atributo SCIM se scim_status estiver definido como "Provisionamento SCIM habilitado") que contém o nome de usuário do usuário que é comparado com o valor da propriedade username do objeto Usuário ao autenticar.Exemplos: uid, userprincipalname, samaccountname, username, userusername, urn:oid:0.9.2342.19200300.100.1.1, urn:oid:1.3.6.1.4.1.5923.1.1.1.13, urn:oid:0.9.2342.19200300.100.1.44 Comportamento da propriedade: - obrigatório se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| sso_url | string | URL do serviço de logon único SAML do provedor de identidade, para o qual o Zabbix enviará as solicitações de autenticação SAML. Exemplo: http://idp.example.com/idp/sso/saml Comportamento da propriedade: - obrigatório se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| slo_url | string | URL do serviço de logout único SAML do provedor de identidade, para o qual o Zabbix enviará as solicitações de logout SAML. Exemplo: https://idp.example.com/idp/slo/saml Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| encrypt_nameid | integer | Se o name ID SAML deve ser criptografado. Valores possíveis: 0 - (padrão) Não criptografar name ID; 1 - Criptografar name ID. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| encrypt_assertions | integer | Se as asserções SAML devem ser criptografadas. Valores possíveis: 0 - (padrão) Não criptografar asserções; 1 - Criptografar asserções. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| nameid_format | string | Formato do name ID do provedor de serviços do provedor de identidade SAML. Exemplos: urn:oasis:names:tc:SAML:2.0:nameid-format:persistent urn:oasis:names:tc:SAML:2.0:nameid-format:transient urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos urn:oasis:names:tc:SAML:2.0:nameid-format:entity Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| scim_status | integer | Se o provisionamento SCIM para SAML está habilitado ou desabilitado. Valores possíveis: 0 - (padrão) Provisionamento SCIM desabilitado; 1 - Provisionamento SCIM habilitado. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| sign_assertions | integer | Se as asserções SAML devem ser assinadas com uma assinatura SAML. Valores possíveis: 0 - (padrão) Não assinar asserções; 1 - Assinar asserções. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| sign_authn_requests | integer | Se as solicitações SAML AuthN devem ser assinadas com uma assinatura SAML. Valores possíveis: 0 - (padrão) Não assinar solicitações AuthN; 1 - Assinar solicitações AuthN. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| sign_messages | integer | Se as mensagens SAML devem ser assinadas com uma assinatura SAML. Valores possíveis: 0 - (padrão) Não assinar mensagens; 1 - Assinar mensagens. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| sign_logout_requests | integer | Se as solicitações de logout SAML devem ser assinadas com uma assinatura SAML. Valores possíveis: 0 - (padrão) Não assinar solicitações de logout; 1 - Assinar solicitações de logout. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| sign_logout_responses | integer | Se as respostas de logout SAML devem ser assinadas com uma assinatura SAML. Valores possíveis: 0 - (padrão) Não assinar respostas de logout; 1 - Assinar respostas de logout. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" |
| idp_certificate | string | Conteúdo do certificado do Provedor de Serviços (SP) para configuração do serviço de logon único (SSO) SAML. Exemplos: -----BEGIN CERTIFICATE----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7... ...mais dados codificados... -----END CERTIFICATE----- Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" e $SSO['CERT_STORAGE'] estiver definido como database em zabbix.conf.php- somente gravação |
| sp_private_key | string | Conteúdo da Chave Privada do Provedor de Serviços (SP) para configuração do serviço de logon único (SSO) SAML. Fornece autenticação segura e troca de dados com o Provedor de Identidade (IdP). Exemplos: -----BEGIN CERTIFICATE----- MIIEvQIBADANBgkqhkiG9w0BA... ...mais dados codificados... -----END CERTIFICATE----- Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" e $SSO['CERT_STORAGE'] estiver definido como database em zabbix.conf.php- somente gravação |
| sp_certificate | string | Conteúdo do certificado do Provedor de Serviços (SP) para configuração do serviço de logon único (SSO) SAML. Exemplos: -----BEGIN CERTIFICATE----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7... ...mais dados codificados... -----END CERTIFICATE----- Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" e $SSO['CERT_STORAGE'] estiver definido como database em zabbix.conf.php- somente gravação |
| idp_certificate_hash | string | O hash md5 do valor de idp_certificate. Retornará uma string vazia para idp_certificate vazio. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" e $SSO['CERT_STORAGE'] estiver definido como database em zabbix.conf.php- somente leitura |
| sp_private_key_hash | string | O hash md5 do valor de sp_private_key. Retornará uma string vazia para sp_private_key vazio. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" e $SSO['CERT_STORAGE'] estiver definido como database em zabbix.conf.php- somente leitura |
| sp_certificate_hash | string | O hash md5 do valor de sp_certificate. Retornará uma string vazia para sp_certificate vazio. Comportamento da propriedade: - suportado se idp_type estiver definido como "Diretório de usuários do tipo SAML" e $SSO['CERT_STORAGE'] estiver definido como database em zabbix.conf.php- somente leitura |
Mapeamentos de tipos de mídia
O objeto de mapeamentos de tipos de mídia possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| userdirectory_mediaid | ID | ID do mapeamento de tipo de mídia. Comportamento da propriedade: - somente leitura |
| name | string | Nome visível na lista de mapeamentos de tipos de mídia. Comportamento da propriedade: - obrigatório |
| mediatypeid | ID | ID do tipo de mídia a ser criado; usado como valor para a propriedade mediatypeid do objeto Media.Comportamento da propriedade: - obrigatório |
| attribute | string | Atributo do diretório de usuários LDAP/SAML (também atributo SCIM se scim_status estiver definido como "Provisionamento SCIM habilitado") que contém a mídia do usuário (por exemplo, [email protected]) que é usada como valor para a propriedade sendto do objeto Media.Se presente nos dados recebidos do provedor de identidade LDAP/SAML, e o valor não estiver vazio, isso acionará a criação de mídia para o usuário provisionado. Comportamento da propriedade: - obrigatório |
| active | integer | Valor da propriedade active da mídia do usuário quando a mídia é criada para o usuário provisionado.Valores possíveis: 0 - (padrão) habilitado; 1 - desabilitado. |
| severity | integer | Valor da propriedade severity da mídia do usuário quando a mídia é criada para o usuário provisionado.Padrão: 63. |
| period | string | Valor da propriedade period da mídia do usuário quando a mídia é criada para o usuário provisionado.Padrão: 1-7,00:00-24:00. |
Mapeamentos de grupos de provisionamento
Os mapeamentos de grupos de provisionamento possuem as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| name | string | Nome completo de um grupo (por exemplo, Zabbix administrators) no diretório de usuários LDAP/SAML (também SCIM se scim_status estiver definido como "Provisionamento SCIM está habilitado").Suporta o caractere curinga "*". Único em todos os mapeamentos de grupos de provisionamento. Comportamento da propriedade: - obrigatório |
| roleid | ID | ID da função de usuário a ser atribuída ao usuário. Se vários mapeamentos de grupos de provisionamento forem correspondidos, a função do tipo de usuário mais alto (User, Admin ou Super admin) será atribuída ao usuário. Se houver várias funções com o mesmo tipo de usuário, a primeira função (ordenada em ordem alfabética) será atribuída ao usuário. Comportamento da propriedade: - obrigatório |
| user_groups | array | Array de objetos de ID de grupo de usuários do Zabbix. Cada objeto possui as seguintes propriedades:usrgrpid - (ID) ID do grupo de usuários do Zabbix a ser atribuído ao usuário.Se vários mapeamentos de grupos de provisionamento forem correspondidos, os grupos de usuários do Zabbix de todos os mapeamentos correspondentes serão atribuídos ao usuário. Comportamento da propriedade: - obrigatório |