saltext.github.utils.gh.members¶
Operations on GitHub organization members.
- saltext.github.utils.gh.members.list_all(conn, *, owner=None, ignore_cache=False)[source]¶
Return the logins of all members of an organization (cached).
- conn
GitHubConnectionto use.- owner
Organization to target. Defaults to the connection’s owner.
- ignore_cache
Bypass the cached member list.
- saltext.github.utils.gh.members.get_info(conn, login, *, owner=None)[source]¶
Return information about a user, including their organization membership state.
- conn
GitHubConnectionto use.- login
User handle to look up.
- owner
Organization to target. Defaults to the connection’s owner.
Raises
GitHubNotFoundErrorif the user does not exist.
- saltext.github.utils.gh.members.invite(conn, login, *, owner=None)[source]¶
Invite a user into the organization. Returns whether the resulting membership state is
pending.- conn
GitHubConnectionto use.- login
User handle to invite.
- owner
Organization to target. Defaults to the connection’s owner.
Raises
GitHubNotFoundErrorif the user does not exist.
- saltext.github.utils.gh.members.remove(conn, login, *, owner=None)[source]¶
Remove a user from the organization (if they are a member).
- conn
GitHubConnectionto use.- login
User handle to remove.
- owner
Organization to target. Defaults to the connection’s owner.
Raises
GitHubNotFoundErrorif the user does not exist.
- saltext.github.utils.gh.members.list_without_mfa(conn, *, owner=None, ignore_cache=False)[source]¶
Return the logins (lowercase) of all organization members without MFA turned on (cached).
- conn
GitHubConnectionto use.- owner
Organization to target. Defaults to the connection’s owner.
- ignore_cache
Bypass the cached member list.