GlideUser - Global

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 6 min. de leitura

    • A API GlideUser fornece métodos para acessar informações sobre o usuário atual e as funções do usuário atual.

    O uso da API GlideUser evita a necessidade de usar as consultas GlideRecord mais lentas para obter informações do usuário.

    GlideUser – getCompanyID()

    Retorna o sys_id da empresa do usuário atual.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 2. Retorna
    Tipo Descrição
    Cadeia de caracteres sys_id da empresa 
    var currentUser = gs.getUser(); 
gs.info(currentUser.getCompanyID());

    Equivalente com escopo

    Para usar o método getCompanyID() em uma aplicação com escopo, use o método com escopo correspondente: getCompanyID().

    GlideUser – getDisplayName()

    Retorna o nome de exibição do usuário atual.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 4. Retorna
    Tipo Descrição
    Cadeia de caracteres Nome de exibição do usuário 
    var currentUser = gs.getUser(); 
gs.info(currentUser.getDisplayName());

    Equivalente com escopo

    Para usar o método getDisplayName() em uma aplicação com escopo, use o método com escopo correspondente: getDisplayName().

    GlideUser – getDomainDisplayValue()

    Retorna o valor de exibição do domínio da sessão do usuário.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 6. Retorna
    Tipo Descrição
    Cadeia de caracteres O valor de exibição do domínio da sessão do usuário. 
    var currentUser = gs.getUser(); 
gs.info(currentUser.getDomainDisplayValue());

    Equivalente com escopo

    Não há solução alternativa para aplicações com escopo.

    GlideUser – getDomainID()

    Retorna o identificador do domínio da sessão atual do usuário.

    O identificador retornado depende do tipo de domínio e da instanciação desse domínio.

    • Se o usuário estiver configurado no domínio global e não usar o seletor de domínio para alternar os domínios, o método retornará nulo.
    • Se o usuário usar o seletor de domínio para alternar para o domínio global, o método retornará a cadeia de caracteres "global".
    • Para todos os outros domínios, o método retorna o sys_id desse domínio.
    Tabela 7. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 8. Retorna
    Tipo Descrição
    Cadeia de caracteres Identificador de domínio. 
    var domain = new GlideRecord('domain');
domain.get(gs.getUser().getDomainID());
gs.info(domain.name);

    GlideUser – getEmail()

    Retorna o endereço de e-mail do usuário.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 10. Retorna
    Tipo Descrição
    Cadeia de caracteres Endereço de e-mail do usuário 
    var currentUser = gs.getUser(); 
gs.info(currentUser.getEmail());

    Equivalente com escopo

    Para usar o método getEmail() em uma aplicação com escopo, use o método com escopo correspondente: getEmail().

    GlideUser – getFirstName()

    Retorna o nome do usuário.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 12. Retorna
    Tipo Descrição
    Objeto/cadeia de caracteres Nome do usuário.
    Nota:
    O tipo de dados do valor retornado é objeto, no entanto, as informações são retornadas como uma cadeia de caracteres.
    		 
    var currentUser = gs.getUser(); 
var userName = currentUser.getFirstName();
gs.info('User First Name: + userName);
gs.info('Data type: ' + typeof userName);
    *** Script: User First Name: John
*** Script: Data type: object

    Equivalente com escopo

    Para usar o método getFirstName() em uma aplicação com escopo, use o método com escopo correspondente: getFirstName().

    GlideUser - getID

    Retorna o sys_id do usuário atual.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 14. Retorna
    Tipo Descrição
    Cadeia de caracteres sys_id do usuário 
    var currentUser = gs.getUser(); 
gs.info(currentUser.getID());

    Equivalente com escopo

    Para usar o método getID() em uma aplicação com escopo, use o método com escopo correspondente: getID().

    GlideUser – getLastName()

    Retorna o sobrenome do usuário.

    Tabela 15. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 16. Retorna
    Tipo Descrição
    Objeto/cadeia de caracteres Sobrenome do usuário.
    Nota:
    O tipo de dados do valor retornado é objeto, no entanto, as informações são retornadas como uma cadeia de caracteres.
    		 
    var currentUser = gs.getUser(); 
var userName = currentUser.getLastName();
gs.info('User Last Name: + userName);
gs.info('Data type: ' + typeof userName);
    *** Script: User Last Name: Smith
*** Script: Data type: object

    Equivalente com escopo

    Para usar o método getLastName() em uma aplicação com escopo, use o método com escopo correspondente: getLastName().

    GlideUser – getMyGroups()

    Retorna um iterador que contém a lista de todos os grupos aos quais o usuário pertence. Somente grupos ativos são retornados.

    Tabela 17. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 18. Retorna
    Tipo Descrição
    iterador Uma lista de sys_ids dos grupos ativos aos quais o usuário pertence.

    O exemplo a seguir mostra como retornar uma lista de grupos aos quais o usuário pertence.

    var groupsArray = gs.getUser().getMyGroups().toArray();
gs.info(groupsArray[0]);
    Saída:
    cfcbad03d711110050f5edcb9e61038f

    Equivalente com escopo

    Não há equivalente com escopo para este método.

    GlideUser – getName()

    Retorna o ID do usuário, ou nome de login, do usuário atual.

    Tabela 19. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 20. Retorna
    Tipo Descrição
    Cadeia de caracteres ID do Usuário 
    var currentUser = gs.getUser(); 
gs.info(currentUser.getName());

    Equivalente com escopo

    Para usar o método getName() em uma aplicação com escopo, use o método com escopo correspondente: getName().

    GlideUser – getRoles()

    Retorna uma lista de funções associadas ao usuário. Inclui funções concedidas explicitamente, funções herdadas e funções adquiridas por associação de grupo.

    Tabela 21. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 22. Retorna
    Tipo Descrição
    Objeto Lista separada por vírgulas de funções de usuário. 
    var currentUser = gs.getUser(); 
gs.info(currentUser.getRoles());

    Saída:

    admin,hr_fulfiller,itsa_fulfiller,security_admin

    Equivalente com escopo

    Para usar o método getRoles() em uma aplicação com escopo, use o método com escopo correspondente: getRoles().

    GlideUser – getUserByID (ID da cadeia de caracteres)

    Retorna o objeto de usuário associado ao ID de usuário passado (sys_id em sys_user) ou user_name.

    Tabela 23. Parâmetros
    Nome Tipo Descrição
    ID Cadeia de caracteres ID exclusivo (sys_id) ou user_name do registro de usuário desejado.
    Tabela 24. Retorna
    Tipo Descrição
    Objeto Objeto de usuário associado ao sys_id ou user_name especificado.

    Exemplo usando nome de usuário (user_name).

    var currentUser = gs.getUser();
gs.info(currentUser.getFirstName()); // print the first name of the logged in user
var newUser = currentUser.getUserByID('abel.tuter'); // fetch a different user using the user_name field
gs.info(newUser.getFirstName()); // print the first name of the Abel Tuter user

    Exemplo usando o ID do usuário (sys_id).

    var currentUser = gs.getUser();
gs.info(currentUser.getFirstName()); // print the first name of the logged in user
var newUser = currentUser.getUserByID('62826bf03710200044e0bfc8bcbe5df1'); // fetch Abel Tuter user using sys_id from sys_user record
gs.info(newUser.getFirstName()); // print the first name of the Abel Tuter user

    GlideUser – getUserRoles()

    Retorna a lista de funções concedidas explicitamente ao usuário.

    Tabela 25. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 26. Retorna
    Tipo Descrição
    Objeto/cadeia de caracteres Lista de funções separadas por vírgulas atribuídas explicitamente ao usuário.
    Nota:
    O tipo de dados do valor retornado é objeto, no entanto, as informações são retornadas como uma cadeia de caracteres.
    		 
    var currentUser = gs.getUser(); 
var userRoles = currentUser.getUserRoles();
gs.info('User Roles: ' + userRoles);
gs.info('Data type: ' + typeof userRoles);
    *** Script: User Roles: ,admin,security_admin
*** Script: Data type: object

    Equivalente com escopo

    Para usar o método getUserRoles() em uma aplicação com escopo, use o método com escopo correspondente: getUserRoles().

    GlideUser - hasRole(cadeia de caracteres função)

    Determina se o usuário atual tem a função especificada.

    Tabela 27. Parâmetros
    Nome Tipo Descrição
    função Cadeia de caracteres Função a ser verificada
    Tabela 28. Retorna
    Tipo Descrição
    Booliano Verdadeiro se o usuário tiver a função. 
    var currentUser = gs.getUser(); 
gs.info(currentUser.hasRole('admin'));

    Equivalente com escopo

    Para usar o método hasRole() em uma aplicação com escopo, use o método com escopo correspondente: hasRole().

    GlideUser - isExplicitMemberOf(cadeia de caracteres grupo)

    Determina se o usuário atual é um membro explícito do grupo especificado. Somente grupos ativos são avaliados por este método.

    O método isMemberOf() retornará verdadeiro para um grupo primário se o usuário for membro do grupo secundário. Use este método se quiser retornar verdadeiro somente para grupos primários.

    Tabela 29. Parâmetros
    Nome Tipo Descrição
    grupo Cadeia de caracteres Sys_id do grupo de usuários a ser verificado.
    Tabela 30. Retorna
    Tipo Descrição
    Booliano

    Sinalizador que indica se o usuário atual é um membro explícito do grupo especificado.

    Valores válidos:
    • verdadeiro: o usuário atual é um membro explícito do grupo especificado.
    • falso: o usuário atual não é um membro explícito do grupo especificado.

    O exemplo a seguir mostra como verificar se o usuário atual é um membro explícito do grupo especificado.

    var isExplMem = gs.getUser().isExplicitMemberOf('b8ef24616fc331003b3c498f5d3ee434');
gs.info(isExplMem);

    Saída:

    false

    Equivalente com escopo

    Não há equivalente com escopo para este método.

    GlideUser - isMemberOf(cadeia de caracteres grupo)

    Determina se o usuário atual é membro do grupo especificado. Somente grupos ativos são avaliados por este método.

    Este método retorna verdadeiro para um grupo primário se o usuário for membro do grupo secundário. Use isExplicitMemberOf() se quiser retornar verdadeiro somente para grupos primários.

    Tabela 31. Parâmetros
    Nome Tipo Descrição
    grupo Cadeia de caracteres Sys_id do grupo de usuários a ser verificado.
    Tabela 32. Retorna
    Tipo Descrição
    Booliano

    Sinalizador que indica se o usuário atual é membro do grupo especificado.

    Valores válidos:
    • verdadeiro: o usuário atual é membro do grupo especificado.
    • falso: o usuário atual não é membro do grupo especificado.

    O exemplo a seguir mostra como verificar se o usuário atual é membro do grupo especificado.

    var currentUser = gs.getUser(); 
gs.info(currentUser.isMemberOf(­'Capacity Mgmt'));

    Equivalente com escopo

    Para usar o método isMemberOf() em uma aplicação com escopo, use o método com escopo correspondente: isMemberOf().