View Source GitHub.EnterpriseAdmin (GitHub REST API Client v0.0.5)

Provides API endpoints related to enterprise admin

Link to this section Summary

Functions

Add organization access to a self-hosted runner group in an enterprise

Create a registration token for an enterprise

Create a remove token for an enterprise

Create a self-hosted runner group for an enterprise

Disable a selected organization for GitHub Actions in an enterprise

Enable a selected organization for GitHub Actions in an enterprise

Get allowed actions and reusable workflows for an enterprise

Get GitHub Actions permissions for an enterprise

Get GitHub Enterprise Server statistics

List labels for a self-hosted runner for an enterprise

List organization access to a self-hosted runner group in an enterprise

List runner applications for an enterprise

List selected organizations enabled for GitHub Actions in an enterprise

List self-hosted runner groups for an enterprise

List self-hosted runners for an enterprise

Remove all custom labels from a self-hosted runner for an enterprise

Remove a custom label from a self-hosted runner for an enterprise

Remove organization access to a self-hosted runner group in an enterprise

Get code security and analysis features for an enterprise

Update code security and analysis features for an enterprise

Set allowed actions and reusable workflows for an enterprise

Set GitHub Actions permissions for an enterprise

Set organization access for a self-hosted runner group in an enterprise

Set selected organizations enabled for GitHub Actions in an enterprise

Link to this section Functions

Link to this function

add_custom_labels_to_self_hosted_runner_for_enterprise(enterprise, runner_id, body, opts \\ [])

View Source
@spec add_custom_labels_to_self_hosted_runner_for_enterprise(
  String.t(),
  integer(),
  map(),
  keyword()
) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

Add custom labels to a self-hosted runner for an enterprise

resources

Resources

Link to this function

add_org_access_to_self_hosted_runner_group_in_enterprise(enterprise, runner_group_id, org_id, opts \\ [])

View Source
@spec add_org_access_to_self_hosted_runner_group_in_enterprise(
  String.t(),
  integer(),
  integer(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Add organization access to a self-hosted runner group in an enterprise

resources

Resources

Link to this function

add_self_hosted_runner_to_group_for_enterprise(enterprise, runner_group_id, runner_id, opts \\ [])

View Source
@spec add_self_hosted_runner_to_group_for_enterprise(
  String.t(),
  integer(),
  integer(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Add a self-hosted runner to a group for an enterprise

resources

Resources

Link to this function

create_registration_token_for_enterprise(enterprise, opts \\ [])

View Source
@spec create_registration_token_for_enterprise(
  String.t(),
  keyword()
) :: {:ok, GitHub.AuthenticationToken.t()} | {:error, GitHub.Error.t()}

Create a registration token for an enterprise

resources

Resources

Link to this function

create_remove_token_for_enterprise(enterprise, opts \\ [])

View Source
@spec create_remove_token_for_enterprise(
  String.t(),
  keyword()
) :: {:ok, GitHub.AuthenticationToken.t()} | {:error, GitHub.Error.t()}

Create a remove token for an enterprise

resources

Resources

Link to this function

create_self_hosted_runner_group_for_enterprise(enterprise, body, opts \\ [])

View Source
@spec create_self_hosted_runner_group_for_enterprise(String.t(), map(), keyword()) ::
  {:ok, GitHub.Actions.Runner.GroupsEnterprise.t()} | {:error, GitHub.Error.t()}

Create a self-hosted runner group for an enterprise

resources

Resources

Link to this function

delete_self_hosted_runner_from_enterprise(enterprise, runner_id, opts \\ [])

View Source
@spec delete_self_hosted_runner_from_enterprise(String.t(), integer(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete a self-hosted runner from an enterprise

resources

Resources

Link to this function

delete_self_hosted_runner_group_from_enterprise(enterprise, runner_group_id, opts \\ [])

View Source
@spec delete_self_hosted_runner_group_from_enterprise(
  String.t(),
  integer(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Delete a self-hosted runner group from an enterprise

resources

Resources

Link to this function

disable_selected_organization_github_actions_enterprise(enterprise, org_id, opts \\ [])

View Source
@spec disable_selected_organization_github_actions_enterprise(
  String.t(),
  integer(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Disable a selected organization for GitHub Actions in an enterprise

resources

Resources

Link to this function

enable_selected_organization_github_actions_enterprise(enterprise, org_id, opts \\ [])

View Source
@spec enable_selected_organization_github_actions_enterprise(
  String.t(),
  integer(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Enable a selected organization for GitHub Actions in an enterprise

resources

Resources

Link to this function

get_allowed_actions_enterprise(enterprise, opts \\ [])

View Source
@spec get_allowed_actions_enterprise(
  String.t(),
  keyword()
) :: {:ok, GitHub.SelectedActions.t()} | {:error, GitHub.Error.t()}

Get allowed actions and reusable workflows for an enterprise

resources

Resources

Link to this function

get_github_actions_permissions_enterprise(enterprise, opts \\ [])

View Source
@spec get_github_actions_permissions_enterprise(
  String.t(),
  keyword()
) ::
  {:ok, GitHub.Actions.EnterprisePermissions.t()} | {:error, GitHub.Error.t()}

Get GitHub Actions permissions for an enterprise

resources

Resources

Link to this function

get_self_hosted_runner_for_enterprise(enterprise, runner_id, opts \\ [])

View Source
@spec get_self_hosted_runner_for_enterprise(String.t(), integer(), keyword()) ::
  {:ok, GitHub.Actions.Runner.t()} | {:error, GitHub.Error.t()}

Get a self-hosted runner for an enterprise

resources

Resources

Link to this function

get_self_hosted_runner_group_for_enterprise(enterprise, runner_group_id, opts \\ [])

View Source
@spec get_self_hosted_runner_group_for_enterprise(String.t(), integer(), keyword()) ::
  {:ok, GitHub.Actions.Runner.GroupsEnterprise.t()} | {:error, GitHub.Error.t()}

Get a self-hosted runner group for an enterprise

resources

Resources

Link to this function

get_server_statistics(enterprise_or_org, opts \\ [])

View Source
@spec get_server_statistics(
  String.t(),
  keyword()
) :: {:ok, [map()]} | {:error, GitHub.Error.t()}

Get GitHub Enterprise Server statistics

options

Options

  • date_start (String.t()): A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.
  • date_end (String.t()): A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

resources

Resources

Link to this function

list_labels_for_self_hosted_runner_for_enterprise(enterprise, runner_id, opts \\ [])

View Source
@spec list_labels_for_self_hosted_runner_for_enterprise(
  String.t(),
  integer(),
  keyword()
) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List labels for a self-hosted runner for an enterprise

resources

Resources

Link to this function

list_org_access_to_self_hosted_runner_group_in_enterprise(enterprise, runner_group_id, opts \\ [])

View Source
@spec list_org_access_to_self_hosted_runner_group_in_enterprise(
  String.t(),
  integer(),
  keyword()
) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List organization access to a self-hosted runner group in an enterprise

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_runner_applications_for_enterprise(enterprise, opts \\ [])

View Source
@spec list_runner_applications_for_enterprise(
  String.t(),
  keyword()
) :: {:ok, [GitHub.Actions.Runner.Application.t()]} | {:error, GitHub.Error.t()}

List runner applications for an enterprise

resources

Resources

Link to this function

list_selected_organizations_enabled_github_actions_enterprise(enterprise, opts \\ [])

View Source
@spec list_selected_organizations_enabled_github_actions_enterprise(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, GitHub.Error.t()}

List selected organizations enabled for GitHub Actions in an enterprise

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_self_hosted_runner_groups_for_enterprise(enterprise, opts \\ [])

View Source
@spec list_self_hosted_runner_groups_for_enterprise(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, GitHub.Error.t()}

List self-hosted runner groups for an enterprise

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.
  • visible_to_organization (String.t()): Only return runner groups that are allowed to be used by this organization.

resources

Resources

Link to this function

list_self_hosted_runners_for_enterprise(enterprise, opts \\ [])

View Source
@spec list_self_hosted_runners_for_enterprise(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, GitHub.Error.t()}

List self-hosted runners for an enterprise

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_self_hosted_runners_in_group_for_enterprise(enterprise, runner_group_id, opts \\ [])

View Source
@spec list_self_hosted_runners_in_group_for_enterprise(
  String.t(),
  integer(),
  keyword()
) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

List self-hosted runners in a group for an enterprise

options

Options

  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

remove_all_custom_labels_from_self_hosted_runner_for_enterprise(enterprise, runner_id, opts \\ [])

View Source
@spec remove_all_custom_labels_from_self_hosted_runner_for_enterprise(
  String.t(),
  integer(),
  keyword()
) :: {:ok, map()} | {:error, GitHub.Error.t()}

Remove all custom labels from a self-hosted runner for an enterprise

resources

Resources

Link to this function

remove_custom_label_from_self_hosted_runner_for_enterprise(enterprise, runner_id, name, opts \\ [])

View Source
@spec remove_custom_label_from_self_hosted_runner_for_enterprise(
  String.t(),
  integer(),
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, GitHub.Error.t()}

Remove a custom label from a self-hosted runner for an enterprise

resources

Resources

Link to this function

remove_org_access_to_self_hosted_runner_group_in_enterprise(enterprise, runner_group_id, org_id, opts \\ [])

View Source
@spec remove_org_access_to_self_hosted_runner_group_in_enterprise(
  String.t(),
  integer(),
  integer(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Remove organization access to a self-hosted runner group in an enterprise

resources

Resources

Link to this function

remove_self_hosted_runner_from_group_for_enterprise(enterprise, runner_group_id, runner_id, opts \\ [])

View Source
@spec remove_self_hosted_runner_from_group_for_enterprise(
  String.t(),
  integer(),
  integer(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Remove a self-hosted runner from a group for an enterprise

resources

Resources

Link to this function

secret_scanning_get_security_analysis_settings_for_enterprise(enterprise, opts \\ [])

View Source
@spec secret_scanning_get_security_analysis_settings_for_enterprise(
  String.t(),
  keyword()
) ::
  {:ok, GitHub.EnterpriseSecurityAnalysisSettings.t()}
  | {:error, GitHub.Error.t()}

Get code security and analysis features for an enterprise

resources

Resources

Link to this function

secret_scanning_patch_security_analysis_settings_for_enterprise(enterprise, body, opts \\ [])

View Source
@spec secret_scanning_patch_security_analysis_settings_for_enterprise(
  String.t(),
  map(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Update code security and analysis features for an enterprise

resources

Resources

Link to this function

secret_scanning_post_security_product_enablement_for_enterprise(enterprise, security_product, enablement, opts \\ [])

View Source
@spec secret_scanning_post_security_product_enablement_for_enterprise(
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Enable or disable a security feature

resources

Resources

Link to this function

set_allowed_actions_enterprise(enterprise, body, opts \\ [])

View Source
@spec set_allowed_actions_enterprise(
  String.t(),
  GitHub.SelectedActions.t(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Set allowed actions and reusable workflows for an enterprise

resources

Resources

Link to this function

set_custom_labels_for_self_hosted_runner_for_enterprise(enterprise, runner_id, body, opts \\ [])

View Source
@spec set_custom_labels_for_self_hosted_runner_for_enterprise(
  String.t(),
  integer(),
  map(),
  keyword()
) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

Set custom labels for a self-hosted runner for an enterprise

resources

Resources

Link to this function

set_github_actions_permissions_enterprise(enterprise, body, opts \\ [])

View Source
@spec set_github_actions_permissions_enterprise(String.t(), map(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Set GitHub Actions permissions for an enterprise

resources

Resources

Link to this function

set_org_access_to_self_hosted_runner_group_in_enterprise(enterprise, runner_group_id, body, opts \\ [])

View Source
@spec set_org_access_to_self_hosted_runner_group_in_enterprise(
  String.t(),
  integer(),
  map(),
  keyword()
) :: :ok | {:error, GitHub.Error.t()}

Set organization access for a self-hosted runner group in an enterprise

resources

Resources

Link to this function

set_selected_organizations_enabled_github_actions_enterprise(enterprise, body, opts \\ [])

View Source
@spec set_selected_organizations_enabled_github_actions_enterprise(
  String.t(),
  map(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Set selected organizations enabled for GitHub Actions in an enterprise

resources

Resources

Link to this function

set_self_hosted_runners_in_group_for_enterprise(enterprise, runner_group_id, body, opts \\ [])

View Source
@spec set_self_hosted_runners_in_group_for_enterprise(
  String.t(),
  integer(),
  map(),
  keyword()
) ::
  :ok | {:error, GitHub.Error.t()}

Set self-hosted runners in a group for an enterprise

resources

Resources

Link to this function

update_self_hosted_runner_group_for_enterprise(enterprise, runner_group_id, body, opts \\ [])

View Source
@spec update_self_hosted_runner_group_for_enterprise(
  String.t(),
  integer(),
  map(),
  keyword()
) ::
  {:ok, GitHub.Actions.Runner.GroupsEnterprise.t()} | {:error, GitHub.Error.t()}

Update a self-hosted runner group for an enterprise

resources

Resources