{ "name": "UnsuspendGithubUser", "fully_qualified_name": "GithubApi.UnsuspendGithubUser@0.1.0", "description": "Unsuspend a user on GitHub Enterprise.\n\nThis tool unsuspends a user on a GitHub Enterprise instance. It is disabled if the GitHub instance uses LDAP Sync with Active Directory LDAP servers, in which case it returns a `403` response. It should be called to restore access to a suspended user.", "toolkit": { "name": "ArcadeGithubApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "github_user_handle", "required": true, "description": "The GitHub user handle to identify the user account to unsuspend.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The handle for the GitHub user account." }, "inferrable": true, "http_endpoint_parameter_name": "username" }, { "name": "unsuspension_reason", "required": false, "description": "The reason for unsuspending the user, logged in the audit log. Defaults to \"Unsuspended via API by _SITE_ADMINISTRATOR_\" if not provided.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.8/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." }, "inferrable": true, "http_endpoint_parameter_name": "reason" } ] }, "output": { "description": "Response from the API endpoint 'enterprise-admin/unsuspend-user'.", "available_modes": [ "value", "error", "null" ], "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "requirements": { "authorization": { "provider_id": "arcade-github", "provider_type": "oauth2", "id": null, "oauth2": null }, "secrets": [ { "key": "GIT_SERVER_URL" } ], "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.1.0", "description": "Tools that enable LLMs to interact directly with the GitHub API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.2.0", "description": "" }, "url": "{git_server_url}/api/v3/users/{username}/suspended", "http_method": "DELETE", "headers": {}, "parameters": [ { "name": "username", "tool_parameter_name": "github_user_handle", "description": "The handle for the GitHub user account.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The handle for the GitHub user account." }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "reason", "tool_parameter_name": "unsuspension_reason", "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.8/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.8/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action." }, "accepted_as": "body", "required": false, "deprecated": false, "default": null, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "GIT_SERVER_URL", "parameter_name": "git_server_url", "accepted_as": "path", "formatted_value": null, "description": "", "is_auth_token": false }, { "arcade_key": "auth_token", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "The OAuth token to use for authentication.", "is_auth_token": true } ], "request_body_spec": "{\n \"content\": {\n \"application/json\": {\n \"examples\": {\n \"reason\": {\n \"value\": {\n \"reason\": \"Unsuspended after leave of absence.\"\n }\n }\n },\n \"schema\": {\n \"nullable\": true,\n \"properties\": {\n \"reason\": {\n \"description\": \"The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.8/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \\\"Unsuspended via API by _SITE\\\\_ADMINISTRATOR_\\\", where _SITE\\\\_ADMINISTRATOR_ is the person who performed the action.\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n }\n }\n }\n}", "use_request_body_schema_mode": false, "validate_request_body_schema": false } }