Struct roctogen::endpoints::enterprise_admin::EnterpriseAdmin [−][src]
pub struct EnterpriseAdmin<'api> { /* fields omitted */ }
Implementations
pub async fn add_custom_labels_to_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32,
body: PostEnterpriseAdminAddCustomLabelsToSelfHostedRunnerForEnterprise
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminAddCustomLabelsToSelfHostedRunnerForEnterpriseError>
pub async fn add_custom_labels_to_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32,
body: PostEnterpriseAdminAddCustomLabelsToSelfHostedRunnerForEnterprise
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminAddCustomLabelsToSelfHostedRunnerForEnterpriseError>
Add custom labels to a self-hosted runner for an enterprise
Add custom labels to a self-hosted runner configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for add_custom_labels_to_self_hosted_runner_for_enterprise
pub fn add_custom_labels_to_self_hosted_runner_for_enterprise(
&self,
enterprise: &str,
runner_id: i32,
body: PostEnterpriseAdminAddCustomLabelsToSelfHostedRunnerForEnterprise
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminAddCustomLabelsToSelfHostedRunnerForEnterpriseError>
pub fn add_custom_labels_to_self_hosted_runner_for_enterprise(
&self,
enterprise: &str,
runner_id: i32,
body: PostEnterpriseAdminAddCustomLabelsToSelfHostedRunnerForEnterprise
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminAddCustomLabelsToSelfHostedRunnerForEnterpriseError>
Add custom labels to a self-hosted runner for an enterprise
Add custom labels to a self-hosted runner configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for add_custom_labels_to_self_hosted_runner_for_enterprise
pub async fn add_org_access_to_self_hosted_runner_group_in_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
org_id: i32
) -> Result<(), EnterpriseAdminAddOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
pub async fn add_org_access_to_self_hosted_runner_group_in_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
org_id: i32
) -> Result<(), EnterpriseAdminAddOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
Add organization access to a self-hosted runner group in an enterprise
Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see “Create a self-hosted runner group for an enterprise.”
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for add_org_access_to_self_hosted_runner_group_in_enterprise
pub fn add_org_access_to_self_hosted_runner_group_in_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
org_id: i32
) -> Result<(), EnterpriseAdminAddOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
pub fn add_org_access_to_self_hosted_runner_group_in_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
org_id: i32
) -> Result<(), EnterpriseAdminAddOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
Add organization access to a self-hosted runner group in an enterprise
Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see “Create a self-hosted runner group for an enterprise.”
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for add_org_access_to_self_hosted_runner_group_in_enterprise
pub async fn add_self_hosted_runner_to_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), EnterpriseAdminAddSelfHostedRunnerToGroupForEnterpriseError>
pub async fn add_self_hosted_runner_to_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), EnterpriseAdminAddSelfHostedRunnerToGroupForEnterpriseError>
Add a self-hosted runner to a group for an enterprise
Adds a self-hosted runner to a runner group configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for add_self_hosted_runner_to_group_for_enterprise
pub fn add_self_hosted_runner_to_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), EnterpriseAdminAddSelfHostedRunnerToGroupForEnterpriseError>
pub fn add_self_hosted_runner_to_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), EnterpriseAdminAddSelfHostedRunnerToGroupForEnterpriseError>
Add a self-hosted runner to a group for an enterprise
Adds a self-hosted runner to a runner group configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for add_self_hosted_runner_to_group_for_enterprise
pub async fn create_registration_token_for_enterprise_async(
&self,
enterprise: &str
) -> Result<AuthenticationToken, EnterpriseAdminCreateRegistrationTokenForEnterpriseError>
pub async fn create_registration_token_for_enterprise_async(
&self,
enterprise: &str
) -> Result<AuthenticationToken, EnterpriseAdminCreateRegistrationTokenForEnterpriseError>
Create a registration token for an enterprise
Returns a token that you can pass to the config
script. The token expires after one hour.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
Example using registration token
Configure your self-hosted runner, replacing TOKEN
with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN
GitHub API docs for create_registration_token_for_enterprise
pub fn create_registration_token_for_enterprise(
&self,
enterprise: &str
) -> Result<AuthenticationToken, EnterpriseAdminCreateRegistrationTokenForEnterpriseError>
pub fn create_registration_token_for_enterprise(
&self,
enterprise: &str
) -> Result<AuthenticationToken, EnterpriseAdminCreateRegistrationTokenForEnterpriseError>
Create a registration token for an enterprise
Returns a token that you can pass to the config
script. The token expires after one hour.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
Example using registration token
Configure your self-hosted runner, replacing TOKEN
with the registration token provided by this endpoint.
./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN
GitHub API docs for create_registration_token_for_enterprise
pub async fn create_remove_token_for_enterprise_async(
&self,
enterprise: &str
) -> Result<AuthenticationToken, EnterpriseAdminCreateRemoveTokenForEnterpriseError>
pub async fn create_remove_token_for_enterprise_async(
&self,
enterprise: &str
) -> Result<AuthenticationToken, EnterpriseAdminCreateRemoveTokenForEnterpriseError>
Create a remove token for an enterprise
Returns a token that you can pass to the config
script to remove a self-hosted runner from an enterprise. The token expires after one hour.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
Example using remove token
To remove your self-hosted runner from an enterprise, replace TOKEN
with the remove token provided by this
endpoint.
./config.sh remove --token TOKEN
GitHub API docs for create_remove_token_for_enterprise
pub fn create_remove_token_for_enterprise(
&self,
enterprise: &str
) -> Result<AuthenticationToken, EnterpriseAdminCreateRemoveTokenForEnterpriseError>
pub fn create_remove_token_for_enterprise(
&self,
enterprise: &str
) -> Result<AuthenticationToken, EnterpriseAdminCreateRemoveTokenForEnterpriseError>
Create a remove token for an enterprise
Returns a token that you can pass to the config
script to remove a self-hosted runner from an enterprise. The token expires after one hour.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
Example using remove token
To remove your self-hosted runner from an enterprise, replace TOKEN
with the remove token provided by this
endpoint.
./config.sh remove --token TOKEN
GitHub API docs for create_remove_token_for_enterprise
pub async fn create_self_hosted_runner_group_for_enterprise_async(
&self,
enterprise: &str,
body: PostEnterpriseAdminCreateSelfHostedRunnerGroupForEnterprise
) -> Result<RunnerGroupsEnterprise, EnterpriseAdminCreateSelfHostedRunnerGroupForEnterpriseError>
pub async fn create_self_hosted_runner_group_for_enterprise_async(
&self,
enterprise: &str,
body: PostEnterpriseAdminCreateSelfHostedRunnerGroupForEnterprise
) -> Result<RunnerGroupsEnterprise, EnterpriseAdminCreateSelfHostedRunnerGroupForEnterpriseError>
Create a self-hosted runner group for an enterprise
Creates a new self-hosted runner group for an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for create_self_hosted_runner_group_for_enterprise
Create a self-hosted runner group for an enterprise
Creates a new self-hosted runner group for an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for create_self_hosted_runner_group_for_enterprise
pub async fn delete_scim_group_from_enterprise_async(
&self,
enterprise: &str,
scim_group_id: &str
) -> Result<(), EnterpriseAdminDeleteScimGroupFromEnterpriseError>
pub async fn delete_scim_group_from_enterprise_async(
&self,
enterprise: &str,
scim_group_id: &str
) -> Result<(), EnterpriseAdminDeleteScimGroupFromEnterpriseError>
Delete a SCIM group from an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
GitHub API docs for delete_scim_group_from_enterprise
pub fn delete_scim_group_from_enterprise(
&self,
enterprise: &str,
scim_group_id: &str
) -> Result<(), EnterpriseAdminDeleteScimGroupFromEnterpriseError>
pub fn delete_scim_group_from_enterprise(
&self,
enterprise: &str,
scim_group_id: &str
) -> Result<(), EnterpriseAdminDeleteScimGroupFromEnterpriseError>
Delete a SCIM group from an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
GitHub API docs for delete_scim_group_from_enterprise
pub async fn delete_self_hosted_runner_from_enterprise_async(
&self,
enterprise: &str,
runner_id: i32
) -> Result<(), EnterpriseAdminDeleteSelfHostedRunnerFromEnterpriseError>
pub async fn delete_self_hosted_runner_from_enterprise_async(
&self,
enterprise: &str,
runner_id: i32
) -> Result<(), EnterpriseAdminDeleteSelfHostedRunnerFromEnterpriseError>
Delete a self-hosted runner from an enterprise
Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for delete_self_hosted_runner_from_enterprise
pub fn delete_self_hosted_runner_from_enterprise(
&self,
enterprise: &str,
runner_id: i32
) -> Result<(), EnterpriseAdminDeleteSelfHostedRunnerFromEnterpriseError>
pub fn delete_self_hosted_runner_from_enterprise(
&self,
enterprise: &str,
runner_id: i32
) -> Result<(), EnterpriseAdminDeleteSelfHostedRunnerFromEnterpriseError>
Delete a self-hosted runner from an enterprise
Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for delete_self_hosted_runner_from_enterprise
pub async fn delete_self_hosted_runner_group_from_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32
) -> Result<(), EnterpriseAdminDeleteSelfHostedRunnerGroupFromEnterpriseError>
pub async fn delete_self_hosted_runner_group_from_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32
) -> Result<(), EnterpriseAdminDeleteSelfHostedRunnerGroupFromEnterpriseError>
Delete a self-hosted runner group from an enterprise
Deletes a self-hosted runner group for an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for delete_self_hosted_runner_group_from_enterprise
pub fn delete_self_hosted_runner_group_from_enterprise(
&self,
enterprise: &str,
runner_group_id: i32
) -> Result<(), EnterpriseAdminDeleteSelfHostedRunnerGroupFromEnterpriseError>
pub fn delete_self_hosted_runner_group_from_enterprise(
&self,
enterprise: &str,
runner_group_id: i32
) -> Result<(), EnterpriseAdminDeleteSelfHostedRunnerGroupFromEnterpriseError>
Delete a self-hosted runner group from an enterprise
Deletes a self-hosted runner group for an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for delete_self_hosted_runner_group_from_enterprise
pub async fn delete_user_from_enterprise_async(
&self,
enterprise: &str,
scim_user_id: &str
) -> Result<(), EnterpriseAdminDeleteUserFromEnterpriseError>
pub async fn delete_user_from_enterprise_async(
&self,
enterprise: &str,
scim_user_id: &str
) -> Result<(), EnterpriseAdminDeleteUserFromEnterpriseError>
Delete a SCIM user from an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
GitHub API docs for delete_user_from_enterprise
pub fn delete_user_from_enterprise(
&self,
enterprise: &str,
scim_user_id: &str
) -> Result<(), EnterpriseAdminDeleteUserFromEnterpriseError>
pub fn delete_user_from_enterprise(
&self,
enterprise: &str,
scim_user_id: &str
) -> Result<(), EnterpriseAdminDeleteUserFromEnterpriseError>
Delete a SCIM user from an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
GitHub API docs for delete_user_from_enterprise
pub async fn disable_selected_organization_github_actions_enterprise_async(
&self,
enterprise: &str,
org_id: i32
) -> Result<(), EnterpriseAdminDisableSelectedOrganizationGithubActionsEnterpriseError>
pub async fn disable_selected_organization_github_actions_enterprise_async(
&self,
enterprise: &str,
org_id: i32
) -> Result<(), EnterpriseAdminDisableSelectedOrganizationGithubActionsEnterpriseError>
Disable a selected organization for GitHub Actions in an enterprise
Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for disable_selected_organization_github_actions_enterprise
pub fn disable_selected_organization_github_actions_enterprise(
&self,
enterprise: &str,
org_id: i32
) -> Result<(), EnterpriseAdminDisableSelectedOrganizationGithubActionsEnterpriseError>
pub fn disable_selected_organization_github_actions_enterprise(
&self,
enterprise: &str,
org_id: i32
) -> Result<(), EnterpriseAdminDisableSelectedOrganizationGithubActionsEnterpriseError>
Disable a selected organization for GitHub Actions in an enterprise
Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for disable_selected_organization_github_actions_enterprise
pub async fn enable_selected_organization_github_actions_enterprise_async(
&self,
enterprise: &str,
org_id: i32
) -> Result<(), EnterpriseAdminEnableSelectedOrganizationGithubActionsEnterpriseError>
pub async fn enable_selected_organization_github_actions_enterprise_async(
&self,
enterprise: &str,
org_id: i32
) -> Result<(), EnterpriseAdminEnableSelectedOrganizationGithubActionsEnterpriseError>
Enable a selected organization for GitHub Actions in an enterprise
Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for enable_selected_organization_github_actions_enterprise
pub fn enable_selected_organization_github_actions_enterprise(
&self,
enterprise: &str,
org_id: i32
) -> Result<(), EnterpriseAdminEnableSelectedOrganizationGithubActionsEnterpriseError>
pub fn enable_selected_organization_github_actions_enterprise(
&self,
enterprise: &str,
org_id: i32
) -> Result<(), EnterpriseAdminEnableSelectedOrganizationGithubActionsEnterpriseError>
Enable a selected organization for GitHub Actions in an enterprise
Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for enable_selected_organization_github_actions_enterprise
pub async fn get_allowed_actions_enterprise_async(
&self,
enterprise: &str
) -> Result<PutActionsSetAllowedActionsRepository, EnterpriseAdminGetAllowedActionsEnterpriseError>
pub async fn get_allowed_actions_enterprise_async(
&self,
enterprise: &str
) -> Result<PutActionsSetAllowedActionsRepository, EnterpriseAdminGetAllowedActionsEnterpriseError>
Get allowed actions for an enterprise
Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for get_allowed_actions_enterprise
pub fn get_allowed_actions_enterprise(
&self,
enterprise: &str
) -> Result<PutActionsSetAllowedActionsRepository, EnterpriseAdminGetAllowedActionsEnterpriseError>
pub fn get_allowed_actions_enterprise(
&self,
enterprise: &str
) -> Result<PutActionsSetAllowedActionsRepository, EnterpriseAdminGetAllowedActionsEnterpriseError>
Get allowed actions for an enterprise
Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for get_allowed_actions_enterprise
pub async fn get_audit_log_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminGetAuditLogParams<'api>>>
) -> Result<Vec<AuditLogEvent>, EnterpriseAdminGetAuditLogError>
pub async fn get_audit_log_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminGetAuditLogParams<'api>>>
) -> Result<Vec<AuditLogEvent>, EnterpriseAdminGetAuditLogError>
Get the audit log for an enterprise
Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the admin:enterprise
scope.
GitHub API docs for get_audit_log
pub fn get_audit_log(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminGetAuditLogParams<'api>>>
) -> Result<Vec<AuditLogEvent>, EnterpriseAdminGetAuditLogError>
pub fn get_audit_log(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminGetAuditLogParams<'api>>>
) -> Result<Vec<AuditLogEvent>, EnterpriseAdminGetAuditLogError>
Get the audit log for an enterprise
Gets the audit log for an enterprise. To use this endpoint, you must be an enterprise admin, and you must use an access token with the admin:enterprise
scope.
GitHub API docs for get_audit_log
pub async fn get_github_actions_permissions_enterprise_async(
&self,
enterprise: &str
) -> Result<ActionsEnterprisePermissions, EnterpriseAdminGetGithubActionsPermissionsEnterpriseError>
pub async fn get_github_actions_permissions_enterprise_async(
&self,
enterprise: &str
) -> Result<ActionsEnterprisePermissions, EnterpriseAdminGetGithubActionsPermissionsEnterpriseError>
Get GitHub Actions permissions for an enterprise
Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for get_github_actions_permissions_enterprise
pub fn get_github_actions_permissions_enterprise(
&self,
enterprise: &str
) -> Result<ActionsEnterprisePermissions, EnterpriseAdminGetGithubActionsPermissionsEnterpriseError>
pub fn get_github_actions_permissions_enterprise(
&self,
enterprise: &str
) -> Result<ActionsEnterprisePermissions, EnterpriseAdminGetGithubActionsPermissionsEnterpriseError>
Get GitHub Actions permissions for an enterprise
Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for get_github_actions_permissions_enterprise
pub async fn get_provisioning_information_for_enterprise_group_async(
&self,
enterprise: &str,
scim_group_id: &str,
query_params: Option<impl Into<EnterpriseAdminGetProvisioningInformationForEnterpriseGroupParams<'api>>>
) -> Result<ScimEnterpriseGroup, EnterpriseAdminGetProvisioningInformationForEnterpriseGroupError>
pub async fn get_provisioning_information_for_enterprise_group_async(
&self,
enterprise: &str,
scim_group_id: &str,
query_params: Option<impl Into<EnterpriseAdminGetProvisioningInformationForEnterpriseGroupParams<'api>>>
) -> Result<ScimEnterpriseGroup, EnterpriseAdminGetProvisioningInformationForEnterpriseGroupError>
Get SCIM provisioning information for an enterprise group
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
GitHub API docs for get_provisioning_information_for_enterprise_group
pub fn get_provisioning_information_for_enterprise_group(
&self,
enterprise: &str,
scim_group_id: &str,
query_params: Option<impl Into<EnterpriseAdminGetProvisioningInformationForEnterpriseGroupParams<'api>>>
) -> Result<ScimEnterpriseGroup, EnterpriseAdminGetProvisioningInformationForEnterpriseGroupError>
pub fn get_provisioning_information_for_enterprise_group(
&self,
enterprise: &str,
scim_group_id: &str,
query_params: Option<impl Into<EnterpriseAdminGetProvisioningInformationForEnterpriseGroupParams<'api>>>
) -> Result<ScimEnterpriseGroup, EnterpriseAdminGetProvisioningInformationForEnterpriseGroupError>
Get SCIM provisioning information for an enterprise group
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
GitHub API docs for get_provisioning_information_for_enterprise_group
pub async fn get_provisioning_information_for_enterprise_user_async(
&self,
enterprise: &str,
scim_user_id: &str
) -> Result<ScimEnterpriseUser, EnterpriseAdminGetProvisioningInformationForEnterpriseUserError>
pub async fn get_provisioning_information_for_enterprise_user_async(
&self,
enterprise: &str,
scim_user_id: &str
) -> Result<ScimEnterpriseUser, EnterpriseAdminGetProvisioningInformationForEnterpriseUserError>
Get SCIM provisioning information for an enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
GitHub API docs for get_provisioning_information_for_enterprise_user
pub fn get_provisioning_information_for_enterprise_user(
&self,
enterprise: &str,
scim_user_id: &str
) -> Result<ScimEnterpriseUser, EnterpriseAdminGetProvisioningInformationForEnterpriseUserError>
pub fn get_provisioning_information_for_enterprise_user(
&self,
enterprise: &str,
scim_user_id: &str
) -> Result<ScimEnterpriseUser, EnterpriseAdminGetProvisioningInformationForEnterpriseUserError>
Get SCIM provisioning information for an enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
GitHub API docs for get_provisioning_information_for_enterprise_user
pub async fn get_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32
) -> Result<Runner, EnterpriseAdminGetSelfHostedRunnerForEnterpriseError>
pub async fn get_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32
) -> Result<Runner, EnterpriseAdminGetSelfHostedRunnerForEnterpriseError>
Get a self-hosted runner for an enterprise
Gets a specific self-hosted runner configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for get_self_hosted_runner_for_enterprise
pub fn get_self_hosted_runner_for_enterprise(
&self,
enterprise: &str,
runner_id: i32
) -> Result<Runner, EnterpriseAdminGetSelfHostedRunnerForEnterpriseError>
pub fn get_self_hosted_runner_for_enterprise(
&self,
enterprise: &str,
runner_id: i32
) -> Result<Runner, EnterpriseAdminGetSelfHostedRunnerForEnterpriseError>
Get a self-hosted runner for an enterprise
Gets a specific self-hosted runner configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for get_self_hosted_runner_for_enterprise
pub async fn get_self_hosted_runner_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32
) -> Result<RunnerGroupsEnterprise, EnterpriseAdminGetSelfHostedRunnerGroupForEnterpriseError>
pub async fn get_self_hosted_runner_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32
) -> Result<RunnerGroupsEnterprise, EnterpriseAdminGetSelfHostedRunnerGroupForEnterpriseError>
Get a self-hosted runner group for an enterprise
Gets a specific self-hosted runner group for an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for get_self_hosted_runner_group_for_enterprise
pub fn get_self_hosted_runner_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32
) -> Result<RunnerGroupsEnterprise, EnterpriseAdminGetSelfHostedRunnerGroupForEnterpriseError>
pub fn get_self_hosted_runner_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32
) -> Result<RunnerGroupsEnterprise, EnterpriseAdminGetSelfHostedRunnerGroupForEnterpriseError>
Get a self-hosted runner group for an enterprise
Gets a specific self-hosted runner group for an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for get_self_hosted_runner_group_for_enterprise
pub async fn list_labels_for_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminListLabelsForSelfHostedRunnerForEnterpriseError>
pub async fn list_labels_for_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminListLabelsForSelfHostedRunnerForEnterpriseError>
List labels for a self-hosted runner for an enterprise
Lists all labels for a self-hosted runner configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_labels_for_self_hosted_runner_for_enterprise
pub fn list_labels_for_self_hosted_runner_for_enterprise(
&self,
enterprise: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminListLabelsForSelfHostedRunnerForEnterpriseError>
pub fn list_labels_for_self_hosted_runner_for_enterprise(
&self,
enterprise: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminListLabelsForSelfHostedRunnerForEnterpriseError>
List labels for a self-hosted runner for an enterprise
Lists all labels for a self-hosted runner configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_labels_for_self_hosted_runner_for_enterprise
pub async fn list_org_access_to_self_hosted_runner_group_in_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
query_params: Option<impl Into<EnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseParams>>
) -> Result<GetEnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseResponse200, EnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
pub async fn list_org_access_to_self_hosted_runner_group_in_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
query_params: Option<impl Into<EnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseParams>>
) -> Result<GetEnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseResponse200, EnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
List organization access to a self-hosted runner group in an enterprise
Lists the organizations with access to a self-hosted runner group.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_org_access_to_self_hosted_runner_group_in_enterprise
pub fn list_org_access_to_self_hosted_runner_group_in_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
query_params: Option<impl Into<EnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseParams>>
) -> Result<GetEnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseResponse200, EnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
pub fn list_org_access_to_self_hosted_runner_group_in_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
query_params: Option<impl Into<EnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseParams>>
) -> Result<GetEnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseResponse200, EnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
List organization access to a self-hosted runner group in an enterprise
Lists the organizations with access to a self-hosted runner group.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_org_access_to_self_hosted_runner_group_in_enterprise
pub async fn list_provisioned_groups_enterprise_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListProvisionedGroupsEnterpriseParams<'api>>>
) -> Result<ScimGroupListEnterprise, EnterpriseAdminListProvisionedGroupsEnterpriseError>
pub async fn list_provisioned_groups_enterprise_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListProvisionedGroupsEnterpriseParams<'api>>>
) -> Result<ScimGroupListEnterprise, EnterpriseAdminListProvisionedGroupsEnterpriseError>
List provisioned SCIM groups for an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
GitHub API docs for list_provisioned_groups_enterprise
pub fn list_provisioned_groups_enterprise(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListProvisionedGroupsEnterpriseParams<'api>>>
) -> Result<ScimGroupListEnterprise, EnterpriseAdminListProvisionedGroupsEnterpriseError>
pub fn list_provisioned_groups_enterprise(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListProvisionedGroupsEnterpriseParams<'api>>>
) -> Result<ScimGroupListEnterprise, EnterpriseAdminListProvisionedGroupsEnterpriseError>
List provisioned SCIM groups for an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
GitHub API docs for list_provisioned_groups_enterprise
pub async fn list_provisioned_identities_enterprise_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListProvisionedIdentitiesEnterpriseParams<'api>>>
) -> Result<ScimUserListEnterprise, EnterpriseAdminListProvisionedIdentitiesEnterpriseError>
pub async fn list_provisioned_identities_enterprise_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListProvisionedIdentitiesEnterpriseParams<'api>>>
) -> Result<ScimUserListEnterprise, EnterpriseAdminListProvisionedIdentitiesEnterpriseError>
List SCIM provisioned identities for an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Retrieves a paginated list of all provisioned enterprise members, including pending invitations.
When a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account’s metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:
- When a user with a SCIM-provisioned external identity is removed from an enterprise, the account’s metadata is preserved to allow the user to re-join the organization in the future.
- When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted).
- When a user is invited over SCIM, an external identity is created that matches with the invitee’s email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO.
The returned list of external identities can include an entry for a null
user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:
-
The user is granted access by the IdP and is not a member of the GitHub enterprise.
-
The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account.
-
After successfully authenticating with the SAML SSO IdP, the
null
external identity entry is created and the user is prompted to sign in to their GitHub account:- If the user signs in, their GitHub account is linked to this entry.
- If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity
null
entry remains in place.
GitHub API docs for list_provisioned_identities_enterprise
pub fn list_provisioned_identities_enterprise(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListProvisionedIdentitiesEnterpriseParams<'api>>>
) -> Result<ScimUserListEnterprise, EnterpriseAdminListProvisionedIdentitiesEnterpriseError>
pub fn list_provisioned_identities_enterprise(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListProvisionedIdentitiesEnterpriseParams<'api>>>
) -> Result<ScimUserListEnterprise, EnterpriseAdminListProvisionedIdentitiesEnterpriseError>
List SCIM provisioned identities for an enterprise
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Retrieves a paginated list of all provisioned enterprise members, including pending invitations.
When a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account’s metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub. This can happen in certain cases where an external identity associated with an organization will not match an organization member:
- When a user with a SCIM-provisioned external identity is removed from an enterprise, the account’s metadata is preserved to allow the user to re-join the organization in the future.
- When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted).
- When a user is invited over SCIM, an external identity is created that matches with the invitee’s email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO.
The returned list of external identities can include an entry for a null
user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub account after completing SSO:
-
The user is granted access by the IdP and is not a member of the GitHub enterprise.
-
The user attempts to access the GitHub enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub account.
-
After successfully authenticating with the SAML SSO IdP, the
null
external identity entry is created and the user is prompted to sign in to their GitHub account:- If the user signs in, their GitHub account is linked to this entry.
- If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub enterprise, and the external identity
null
entry remains in place.
GitHub API docs for list_provisioned_identities_enterprise
pub async fn list_runner_applications_for_enterprise_async(
&self,
enterprise: &str
) -> Result<Vec<RunnerApplication>, EnterpriseAdminListRunnerApplicationsForEnterpriseError>
pub async fn list_runner_applications_for_enterprise_async(
&self,
enterprise: &str
) -> Result<Vec<RunnerApplication>, EnterpriseAdminListRunnerApplicationsForEnterpriseError>
List runner applications for an enterprise
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_runner_applications_for_enterprise
pub fn list_runner_applications_for_enterprise(
&self,
enterprise: &str
) -> Result<Vec<RunnerApplication>, EnterpriseAdminListRunnerApplicationsForEnterpriseError>
pub fn list_runner_applications_for_enterprise(
&self,
enterprise: &str
) -> Result<Vec<RunnerApplication>, EnterpriseAdminListRunnerApplicationsForEnterpriseError>
List runner applications for an enterprise
Lists binaries for the runner application that you can download and run.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_runner_applications_for_enterprise
pub async fn list_selected_organizations_enabled_github_actions_enterprise_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelectedOrganizationsEnabledGithubActionsEnterpriseParams>>
) -> Result<GetEnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseResponse200, EnterpriseAdminListSelectedOrganizationsEnabledGithubActionsEnterpriseError>
pub async fn list_selected_organizations_enabled_github_actions_enterprise_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelectedOrganizationsEnabledGithubActionsEnterpriseParams>>
) -> Result<GetEnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseResponse200, EnterpriseAdminListSelectedOrganizationsEnabledGithubActionsEnterpriseError>
List selected organizations enabled for GitHub Actions in an enterprise
Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for list_selected_organizations_enabled_github_actions_enterprise
pub fn list_selected_organizations_enabled_github_actions_enterprise(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelectedOrganizationsEnabledGithubActionsEnterpriseParams>>
) -> Result<GetEnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseResponse200, EnterpriseAdminListSelectedOrganizationsEnabledGithubActionsEnterpriseError>
pub fn list_selected_organizations_enabled_github_actions_enterprise(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelectedOrganizationsEnabledGithubActionsEnterpriseParams>>
) -> Result<GetEnterpriseAdminListOrgAccessToSelfHostedRunnerGroupInEnterpriseResponse200, EnterpriseAdminListSelectedOrganizationsEnabledGithubActionsEnterpriseError>
List selected organizations enabled for GitHub Actions in an enterprise
Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for list_selected_organizations_enabled_github_actions_enterprise
pub async fn list_self_hosted_runner_groups_for_enterprise_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseParams>>
) -> Result<GetEnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseResponse200, EnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseError>
pub async fn list_self_hosted_runner_groups_for_enterprise_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseParams>>
) -> Result<GetEnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseResponse200, EnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseError>
List self-hosted runner groups for an enterprise
Lists all self-hosted runner groups for an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_self_hosted_runner_groups_for_enterprise
pub fn list_self_hosted_runner_groups_for_enterprise(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseParams>>
) -> Result<GetEnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseResponse200, EnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseError>
pub fn list_self_hosted_runner_groups_for_enterprise(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseParams>>
) -> Result<GetEnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseResponse200, EnterpriseAdminListSelfHostedRunnerGroupsForEnterpriseError>
List self-hosted runner groups for an enterprise
Lists all self-hosted runner groups for an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_self_hosted_runner_groups_for_enterprise
pub async fn list_self_hosted_runners_for_enterprise_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnersForEnterpriseParams>>
) -> Result<GetEnterpriseAdminListSelfHostedRunnersForEnterpriseResponse200, EnterpriseAdminListSelfHostedRunnersForEnterpriseError>
pub async fn list_self_hosted_runners_for_enterprise_async(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnersForEnterpriseParams>>
) -> Result<GetEnterpriseAdminListSelfHostedRunnersForEnterpriseResponse200, EnterpriseAdminListSelfHostedRunnersForEnterpriseError>
List self-hosted runners for an enterprise
Lists all self-hosted runners configured for an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_self_hosted_runners_for_enterprise
pub fn list_self_hosted_runners_for_enterprise(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnersForEnterpriseParams>>
) -> Result<GetEnterpriseAdminListSelfHostedRunnersForEnterpriseResponse200, EnterpriseAdminListSelfHostedRunnersForEnterpriseError>
pub fn list_self_hosted_runners_for_enterprise(
&self,
enterprise: &str,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnersForEnterpriseParams>>
) -> Result<GetEnterpriseAdminListSelfHostedRunnersForEnterpriseResponse200, EnterpriseAdminListSelfHostedRunnersForEnterpriseError>
List self-hosted runners for an enterprise
Lists all self-hosted runners configured for an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_self_hosted_runners_for_enterprise
pub async fn list_self_hosted_runners_in_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnersInGroupForEnterpriseParams>>
) -> Result<GetActionsListSelfHostedRunnersInGroupForOrgResponse200, EnterpriseAdminListSelfHostedRunnersInGroupForEnterpriseError>
pub async fn list_self_hosted_runners_in_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnersInGroupForEnterpriseParams>>
) -> Result<GetActionsListSelfHostedRunnersInGroupForOrgResponse200, EnterpriseAdminListSelfHostedRunnersInGroupForEnterpriseError>
List self-hosted runners in a group for an enterprise
Lists the self-hosted runners that are in a specific enterprise group.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_self_hosted_runners_in_group_for_enterprise
pub fn list_self_hosted_runners_in_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnersInGroupForEnterpriseParams>>
) -> Result<GetActionsListSelfHostedRunnersInGroupForOrgResponse200, EnterpriseAdminListSelfHostedRunnersInGroupForEnterpriseError>
pub fn list_self_hosted_runners_in_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
query_params: Option<impl Into<EnterpriseAdminListSelfHostedRunnersInGroupForEnterpriseParams>>
) -> Result<GetActionsListSelfHostedRunnersInGroupForOrgResponse200, EnterpriseAdminListSelfHostedRunnersInGroupForEnterpriseError>
List self-hosted runners in a group for an enterprise
Lists the self-hosted runners that are in a specific enterprise group.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for list_self_hosted_runners_in_group_for_enterprise
pub async fn provision_and_invite_enterprise_group_async(
&self,
enterprise: &str,
body: PostEnterpriseAdminProvisionAndInviteEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminProvisionAndInviteEnterpriseGroupError>
pub async fn provision_and_invite_enterprise_group_async(
&self,
enterprise: &str,
body: PostEnterpriseAdminProvisionAndInviteEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminProvisionAndInviteEnterpriseGroupError>
Provision a SCIM enterprise group and invite users
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.
GitHub API docs for provision_and_invite_enterprise_group
pub fn provision_and_invite_enterprise_group(
&self,
enterprise: &str,
body: PostEnterpriseAdminProvisionAndInviteEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminProvisionAndInviteEnterpriseGroupError>
pub fn provision_and_invite_enterprise_group(
&self,
enterprise: &str,
body: PostEnterpriseAdminProvisionAndInviteEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminProvisionAndInviteEnterpriseGroupError>
Provision a SCIM enterprise group and invite users
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Provision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.
GitHub API docs for provision_and_invite_enterprise_group
pub async fn provision_and_invite_enterprise_user_async(
&self,
enterprise: &str,
body: PostEnterpriseAdminProvisionAndInviteEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminProvisionAndInviteEnterpriseUserError>
pub async fn provision_and_invite_enterprise_user_async(
&self,
enterprise: &str,
body: PostEnterpriseAdminProvisionAndInviteEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminProvisionAndInviteEnterpriseUserError>
Provision and invite a SCIM enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Provision enterprise membership for a user, and send organization invitation emails to the email address.
You can optionally include the groups a user will be invited to join. If you do not provide a list of groups
, the user is provisioned for the enterprise, but no organization invitation emails will be sent.
GitHub API docs for provision_and_invite_enterprise_user
pub fn provision_and_invite_enterprise_user(
&self,
enterprise: &str,
body: PostEnterpriseAdminProvisionAndInviteEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminProvisionAndInviteEnterpriseUserError>
pub fn provision_and_invite_enterprise_user(
&self,
enterprise: &str,
body: PostEnterpriseAdminProvisionAndInviteEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminProvisionAndInviteEnterpriseUserError>
Provision and invite a SCIM enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Provision enterprise membership for a user, and send organization invitation emails to the email address.
You can optionally include the groups a user will be invited to join. If you do not provide a list of groups
, the user is provisioned for the enterprise, but no organization invitation emails will be sent.
GitHub API docs for provision_and_invite_enterprise_user
pub async fn remove_all_custom_labels_from_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminRemoveAllCustomLabelsFromSelfHostedRunnerForEnterpriseError>
pub async fn remove_all_custom_labels_from_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminRemoveAllCustomLabelsFromSelfHostedRunnerForEnterpriseError>
Remove all custom labels from a self-hosted runner for an enterprise
Remove all custom labels from a self-hosted runner configured in an enterprise. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for remove_all_custom_labels_from_self_hosted_runner_for_enterprise
Remove all custom labels from a self-hosted runner for an enterprise
Remove all custom labels from a self-hosted runner configured in an enterprise. Returns the remaining read-only labels from the runner.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for remove_all_custom_labels_from_self_hosted_runner_for_enterprise
pub async fn remove_custom_label_from_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminRemoveCustomLabelFromSelfHostedRunnerForEnterpriseError>
pub async fn remove_custom_label_from_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminRemoveCustomLabelFromSelfHostedRunnerForEnterpriseError>
Remove a custom label from a self-hosted runner for an enterprise
Remove a custom label from a self-hosted runner configured in an enterprise. Returns the remaining labels from the runner.
This endpoint returns a 404 Not Found
status if the custom label is not
present on the runner.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for remove_custom_label_from_self_hosted_runner_for_enterprise
pub fn remove_custom_label_from_self_hosted_runner_for_enterprise(
&self,
enterprise: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminRemoveCustomLabelFromSelfHostedRunnerForEnterpriseError>
pub fn remove_custom_label_from_self_hosted_runner_for_enterprise(
&self,
enterprise: &str,
runner_id: i32,
name: &str
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminRemoveCustomLabelFromSelfHostedRunnerForEnterpriseError>
Remove a custom label from a self-hosted runner for an enterprise
Remove a custom label from a self-hosted runner configured in an enterprise. Returns the remaining labels from the runner.
This endpoint returns a 404 Not Found
status if the custom label is not
present on the runner.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for remove_custom_label_from_self_hosted_runner_for_enterprise
pub async fn remove_org_access_to_self_hosted_runner_group_in_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
org_id: i32
) -> Result<(), EnterpriseAdminRemoveOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
pub async fn remove_org_access_to_self_hosted_runner_group_in_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
org_id: i32
) -> Result<(), EnterpriseAdminRemoveOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
Remove organization access to a self-hosted runner group in an enterprise
Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see “Create a self-hosted runner group for an enterprise.”
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for remove_org_access_to_self_hosted_runner_group_in_enterprise
pub fn remove_org_access_to_self_hosted_runner_group_in_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
org_id: i32
) -> Result<(), EnterpriseAdminRemoveOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
pub fn remove_org_access_to_self_hosted_runner_group_in_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
org_id: i32
) -> Result<(), EnterpriseAdminRemoveOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
Remove organization access to a self-hosted runner group in an enterprise
Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have visibility
set to selected
. For more information, see “Create a self-hosted runner group for an enterprise.”
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for remove_org_access_to_self_hosted_runner_group_in_enterprise
pub async fn remove_self_hosted_runner_from_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), EnterpriseAdminRemoveSelfHostedRunnerFromGroupForEnterpriseError>
pub async fn remove_self_hosted_runner_from_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), EnterpriseAdminRemoveSelfHostedRunnerFromGroupForEnterpriseError>
Remove a self-hosted runner from a group for an enterprise
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for remove_self_hosted_runner_from_group_for_enterprise
pub fn remove_self_hosted_runner_from_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), EnterpriseAdminRemoveSelfHostedRunnerFromGroupForEnterpriseError>
pub fn remove_self_hosted_runner_from_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
runner_id: i32
) -> Result<(), EnterpriseAdminRemoveSelfHostedRunnerFromGroupForEnterpriseError>
Remove a self-hosted runner from a group for an enterprise
Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for remove_self_hosted_runner_from_group_for_enterprise
pub async fn set_allowed_actions_enterprise_async(
&self,
enterprise: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), EnterpriseAdminSetAllowedActionsEnterpriseError>
pub async fn set_allowed_actions_enterprise_async(
&self,
enterprise: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), EnterpriseAdminSetAllowedActionsEnterpriseError>
Set allowed actions for an enterprise
Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for set_allowed_actions_enterprise
pub fn set_allowed_actions_enterprise(
&self,
enterprise: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), EnterpriseAdminSetAllowedActionsEnterpriseError>
pub fn set_allowed_actions_enterprise(
&self,
enterprise: &str,
body: PutActionsSetAllowedActionsRepository
) -> Result<(), EnterpriseAdminSetAllowedActionsEnterpriseError>
Set allowed actions for an enterprise
Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for set_allowed_actions_enterprise
pub async fn set_custom_labels_for_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32,
body: PutEnterpriseAdminSetCustomLabelsForSelfHostedRunnerForEnterprise
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminSetCustomLabelsForSelfHostedRunnerForEnterpriseError>
pub async fn set_custom_labels_for_self_hosted_runner_for_enterprise_async(
&self,
enterprise: &str,
runner_id: i32,
body: PutEnterpriseAdminSetCustomLabelsForSelfHostedRunnerForEnterprise
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminSetCustomLabelsForSelfHostedRunnerForEnterpriseError>
Set custom labels for a self-hosted runner for an enterprise
Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for set_custom_labels_for_self_hosted_runner_for_enterprise
pub fn set_custom_labels_for_self_hosted_runner_for_enterprise(
&self,
enterprise: &str,
runner_id: i32,
body: PutEnterpriseAdminSetCustomLabelsForSelfHostedRunnerForEnterprise
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminSetCustomLabelsForSelfHostedRunnerForEnterpriseError>
pub fn set_custom_labels_for_self_hosted_runner_for_enterprise(
&self,
enterprise: &str,
runner_id: i32,
body: PutEnterpriseAdminSetCustomLabelsForSelfHostedRunnerForEnterprise
) -> Result<DeleteActionsRemoveCustomLabelFromSelfHostedRunnerForRepoResponse200, EnterpriseAdminSetCustomLabelsForSelfHostedRunnerForEnterpriseError>
Set custom labels for a self-hosted runner for an enterprise
Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for set_custom_labels_for_self_hosted_runner_for_enterprise
pub async fn set_github_actions_permissions_enterprise_async(
&self,
enterprise: &str,
body: PutEnterpriseAdminSetGithubActionsPermissionsEnterprise
) -> Result<(), EnterpriseAdminSetGithubActionsPermissionsEnterpriseError>
pub async fn set_github_actions_permissions_enterprise_async(
&self,
enterprise: &str,
body: PutEnterpriseAdminSetGithubActionsPermissionsEnterprise
) -> Result<(), EnterpriseAdminSetGithubActionsPermissionsEnterpriseError>
Set GitHub Actions permissions for an enterprise
Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for set_github_actions_permissions_enterprise
pub fn set_github_actions_permissions_enterprise(
&self,
enterprise: &str,
body: PutEnterpriseAdminSetGithubActionsPermissionsEnterprise
) -> Result<(), EnterpriseAdminSetGithubActionsPermissionsEnterpriseError>
pub fn set_github_actions_permissions_enterprise(
&self,
enterprise: &str,
body: PutEnterpriseAdminSetGithubActionsPermissionsEnterprise
) -> Result<(), EnterpriseAdminSetGithubActionsPermissionsEnterpriseError>
Set GitHub Actions permissions for an enterprise
Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for set_github_actions_permissions_enterprise
pub async fn set_information_for_provisioned_enterprise_group_async(
&self,
enterprise: &str,
scim_group_id: &str,
body: PutEnterpriseAdminSetInformationForProvisionedEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminSetInformationForProvisionedEnterpriseGroupError>
pub async fn set_information_for_provisioned_enterprise_group_async(
&self,
enterprise: &str,
scim_group_id: &str,
body: PutEnterpriseAdminSetInformationForProvisionedEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminSetInformationForProvisionedEnterpriseGroupError>
Set SCIM information for a provisioned enterprise group
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don’t provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
GitHub API docs for set_information_for_provisioned_enterprise_group
pub fn set_information_for_provisioned_enterprise_group(
&self,
enterprise: &str,
scim_group_id: &str,
body: PutEnterpriseAdminSetInformationForProvisionedEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminSetInformationForProvisionedEnterpriseGroupError>
pub fn set_information_for_provisioned_enterprise_group(
&self,
enterprise: &str,
scim_group_id: &str,
body: PutEnterpriseAdminSetInformationForProvisionedEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminSetInformationForProvisionedEnterpriseGroupError>
Set SCIM information for a provisioned enterprise group
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Replaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don’t provide will be removed, including group membership. If you want to only update a specific attribute, use the Update an attribute for a SCIM enterprise group endpoint instead.
GitHub API docs for set_information_for_provisioned_enterprise_group
pub async fn set_information_for_provisioned_enterprise_user_async(
&self,
enterprise: &str,
scim_user_id: &str,
body: PutEnterpriseAdminSetInformationForProvisionedEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminSetInformationForProvisionedEnterpriseUserError>
pub async fn set_information_for_provisioned_enterprise_user_async(
&self,
enterprise: &str,
scim_user_id: &str,
body: PutEnterpriseAdminSetInformationForProvisionedEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminSetInformationForProvisionedEnterpriseUserError>
Set SCIM information for a provisioned enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Replaces an existing provisioned user’s information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don’t provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
You must at least provide the required values for the user: userName
, name
, and emails
.
Warning: Setting active: false
removes the user from the enterprise, deletes the external identity, and deletes the associated {scim_user_id}
.
GitHub API docs for set_information_for_provisioned_enterprise_user
pub fn set_information_for_provisioned_enterprise_user(
&self,
enterprise: &str,
scim_user_id: &str,
body: PutEnterpriseAdminSetInformationForProvisionedEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminSetInformationForProvisionedEnterpriseUserError>
pub fn set_information_for_provisioned_enterprise_user(
&self,
enterprise: &str,
scim_user_id: &str,
body: PutEnterpriseAdminSetInformationForProvisionedEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminSetInformationForProvisionedEnterpriseUserError>
Set SCIM information for a provisioned enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Replaces an existing provisioned user’s information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don’t provide will be removed. If you want to only update a specific attribute, use the Update an attribute for a SCIM user endpoint instead.
You must at least provide the required values for the user: userName
, name
, and emails
.
Warning: Setting active: false
removes the user from the enterprise, deletes the external identity, and deletes the associated {scim_user_id}
.
GitHub API docs for set_information_for_provisioned_enterprise_user
pub async fn set_org_access_to_self_hosted_runner_group_in_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
body: PutEnterpriseAdminSetOrgAccessToSelfHostedRunnerGroupInEnterprise
) -> Result<(), EnterpriseAdminSetOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
pub async fn set_org_access_to_self_hosted_runner_group_in_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
body: PutEnterpriseAdminSetOrgAccessToSelfHostedRunnerGroupInEnterprise
) -> Result<(), EnterpriseAdminSetOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
Set organization access for a self-hosted runner group in an enterprise
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for set_org_access_to_self_hosted_runner_group_in_enterprise
pub fn set_org_access_to_self_hosted_runner_group_in_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
body: PutEnterpriseAdminSetOrgAccessToSelfHostedRunnerGroupInEnterprise
) -> Result<(), EnterpriseAdminSetOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
pub fn set_org_access_to_self_hosted_runner_group_in_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
body: PutEnterpriseAdminSetOrgAccessToSelfHostedRunnerGroupInEnterprise
) -> Result<(), EnterpriseAdminSetOrgAccessToSelfHostedRunnerGroupInEnterpriseError>
Set organization access for a self-hosted runner group in an enterprise
Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for set_org_access_to_self_hosted_runner_group_in_enterprise
Set selected organizations enabled for GitHub Actions in an enterprise
Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for set_selected_organizations_enabled_github_actions_enterprise
Set selected organizations enabled for GitHub Actions in an enterprise
Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations
must be configured to selected
. For more information, see “Set GitHub Actions permissions for an enterprise.”
You must authenticate using an access token with the admin:enterprise
scope to use this endpoint.
GitHub API docs for set_selected_organizations_enabled_github_actions_enterprise
pub async fn set_self_hosted_runners_in_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
body: PutEnterpriseAdminSetSelfHostedRunnersInGroupForEnterprise
) -> Result<(), EnterpriseAdminSetSelfHostedRunnersInGroupForEnterpriseError>
pub async fn set_self_hosted_runners_in_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
body: PutEnterpriseAdminSetSelfHostedRunnersInGroupForEnterprise
) -> Result<(), EnterpriseAdminSetSelfHostedRunnersInGroupForEnterpriseError>
Set self-hosted runners in a group for an enterprise
Replaces the list of self-hosted runners that are part of an enterprise runner group.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for set_self_hosted_runners_in_group_for_enterprise
pub fn set_self_hosted_runners_in_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
body: PutEnterpriseAdminSetSelfHostedRunnersInGroupForEnterprise
) -> Result<(), EnterpriseAdminSetSelfHostedRunnersInGroupForEnterpriseError>
pub fn set_self_hosted_runners_in_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
body: PutEnterpriseAdminSetSelfHostedRunnersInGroupForEnterprise
) -> Result<(), EnterpriseAdminSetSelfHostedRunnersInGroupForEnterpriseError>
Set self-hosted runners in a group for an enterprise
Replaces the list of self-hosted runners that are part of an enterprise runner group.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for set_self_hosted_runners_in_group_for_enterprise
pub async fn update_attribute_for_enterprise_group_async(
&self,
enterprise: &str,
scim_group_id: &str,
body: PatchEnterpriseAdminUpdateAttributeForEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminUpdateAttributeForEnterpriseGroupError>
pub async fn update_attribute_for_enterprise_group_async(
&self,
enterprise: &str,
scim_group_id: &str,
body: PatchEnterpriseAdminUpdateAttributeForEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminUpdateAttributeForEnterpriseGroupError>
Update an attribute for a SCIM enterprise group
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
GitHub API docs for update_attribute_for_enterprise_group
pub fn update_attribute_for_enterprise_group(
&self,
enterprise: &str,
scim_group_id: &str,
body: PatchEnterpriseAdminUpdateAttributeForEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminUpdateAttributeForEnterpriseGroupError>
pub fn update_attribute_for_enterprise_group(
&self,
enterprise: &str,
scim_group_id: &str,
body: PatchEnterpriseAdminUpdateAttributeForEnterpriseGroup
) -> Result<ScimEnterpriseGroup, EnterpriseAdminUpdateAttributeForEnterpriseGroupError>
Update an attribute for a SCIM enterprise group
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Allows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the SCIM specification.
GitHub API docs for update_attribute_for_enterprise_group
pub async fn update_attribute_for_enterprise_user_async(
&self,
enterprise: &str,
scim_user_id: &str,
body: PatchEnterpriseAdminUpdateAttributeForEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminUpdateAttributeForEnterpriseUserError>
pub async fn update_attribute_for_enterprise_user_async(
&self,
enterprise: &str,
scim_user_id: &str,
body: PatchEnterpriseAdminUpdateAttributeForEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminUpdateAttributeForEnterpriseUserError>
Update an attribute for a SCIM enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Allows you to change a provisioned user’s individual attributes. To change a user’s values, you must provide a specific Operations
JSON format that contains at least one of the add
, remove
, or replace
operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note: Complicated SCIM path
selectors that include filters are not supported. For example, a path
selector defined as "path": "emails[type eq \"work\"]"
will not work.
Warning: If you set active:false
using the replace
operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated :scim_user_id
.
{
"Operations":[{
"op":"replace",
"value":{
"active":false
}
}]
}
GitHub API docs for update_attribute_for_enterprise_user
pub fn update_attribute_for_enterprise_user(
&self,
enterprise: &str,
scim_user_id: &str,
body: PatchEnterpriseAdminUpdateAttributeForEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminUpdateAttributeForEnterpriseUserError>
pub fn update_attribute_for_enterprise_user(
&self,
enterprise: &str,
scim_user_id: &str,
body: PatchEnterpriseAdminUpdateAttributeForEnterpriseUser
) -> Result<ScimEnterpriseUser, EnterpriseAdminUpdateAttributeForEnterpriseUserError>
Update an attribute for a SCIM enterprise user
Note: The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.
Allows you to change a provisioned user’s individual attributes. To change a user’s values, you must provide a specific Operations
JSON format that contains at least one of the add
, remove
, or replace
operations. For examples and more information on the SCIM operations format, see the SCIM specification.
Note: Complicated SCIM path
selectors that include filters are not supported. For example, a path
selector defined as "path": "emails[type eq \"work\"]"
will not work.
Warning: If you set active:false
using the replace
operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated :scim_user_id
.
{
"Operations":[{
"op":"replace",
"value":{
"active":false
}
}]
}
GitHub API docs for update_attribute_for_enterprise_user
pub async fn update_self_hosted_runner_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
body: PatchEnterpriseAdminUpdateSelfHostedRunnerGroupForEnterprise
) -> Result<RunnerGroupsEnterprise, EnterpriseAdminUpdateSelfHostedRunnerGroupForEnterpriseError>
pub async fn update_self_hosted_runner_group_for_enterprise_async(
&self,
enterprise: &str,
runner_group_id: i32,
body: PatchEnterpriseAdminUpdateSelfHostedRunnerGroupForEnterprise
) -> Result<RunnerGroupsEnterprise, EnterpriseAdminUpdateSelfHostedRunnerGroupForEnterpriseError>
Update a self-hosted runner group for an enterprise
Updates the name
and visibility
of a self-hosted runner group in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for update_self_hosted_runner_group_for_enterprise
pub fn update_self_hosted_runner_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
body: PatchEnterpriseAdminUpdateSelfHostedRunnerGroupForEnterprise
) -> Result<RunnerGroupsEnterprise, EnterpriseAdminUpdateSelfHostedRunnerGroupForEnterpriseError>
pub fn update_self_hosted_runner_group_for_enterprise(
&self,
enterprise: &str,
runner_group_id: i32,
body: PatchEnterpriseAdminUpdateSelfHostedRunnerGroupForEnterprise
) -> Result<RunnerGroupsEnterprise, EnterpriseAdminUpdateSelfHostedRunnerGroupForEnterpriseError>
Update a self-hosted runner group for an enterprise
Updates the name
and visibility
of a self-hosted runner group in an enterprise.
You must authenticate using an access token with the manage_runners:enterprise
scope to use this endpoint.
GitHub API docs for update_self_hosted_runner_group_for_enterprise