github_user

Look up information about GitHub user accounts.

Added in version 1.1.0.

depends:

PyGithub python module

Configuration

This module reads its configuration from profiles, which are described in the configuration guide. All functions accept a profile argument, defaulting to the github profile.

saltext.github.modules.github_user.info(name=None, profile='github')[source]

Return the public profile of a user account. Fails when the account is an organization. Use github.account_info to look up accounts of either type (note that it defaults to the profile’s owner instead of the token’s user).

CLI Example:

salt-call github_user.info github-handle
salt-call github_user.info  # the token's user
name

Login of the user to look up. Defaults to the user the profile’s token belongs to.

profile

Profile configuration name to use. Defaults to github.

saltext.github.modules.github_user.list_keys(name=None, profile='github')[source]

Return the verified public SSH keys of any user as a list of mappings with id and key fields, e.g. for use with the ssh_auth.present state.

CLI Example:

salt-call github_user.list_keys github-handle
salt-call github_user.list_keys  # the token's user
name

Login of the user whose keys to list. Defaults to the user the profile’s token belongs to.

profile

Profile configuration name to use. Defaults to github.