Commit 87b544c5 authored by Bob Van Landuyt's avatar Bob Van Landuyt

Add documentation for external authorization

parent 854f61b6
...@@ -173,6 +173,7 @@ PUT /application/settings ...@@ -173,6 +173,7 @@ PUT /application/settings
| `external_authorization_service_enabled` | boolean | no | Enable using an external authorization service for accessing projects | | `external_authorization_service_enabled` | boolean | no | Enable using an external authorization service for accessing projects |
| `external_authorization_service_url` | string | no | URL to which authorization requests will be directed | | `external_authorization_service_url` | string | no | URL to which authorization requests will be directed |
| `external_authorization_service_default_label` | string | no | The default classification label to use when requesting authorization and no classification label has been specified on the project | | `external_authorization_service_default_label` | string | no | The default classification label to use when requesting authorization and no classification label has been specified on the project |
| `external_authorization_service_timeout` | float | no | The timeout to enforce when performing requests to the external authorization service |
```bash ```bash
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/application/settings?signup_enabled=false&default_project_visibility=internal curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/application/settings?signup_enabled=false&default_project_visibility=internal
...@@ -213,6 +214,7 @@ Example response: ...@@ -213,6 +214,7 @@ Example response:
"polling_interval_multiplier": 1.0, "polling_interval_multiplier": 1.0,
"external_authorization_service_enabled": true, "external_authorization_service_enabled": true,
"external_authorization_service_url": "https://authorize.me", "external_authorization_service_url": "https://authorize.me",
"external_authorization_service_default_label": "default" "external_authorization_service_default_label": "default",
"external_authorization_service_timeout": 0.5
} }
``` ```
...@@ -38,6 +38,9 @@ admin area under the settings page: ...@@ -38,6 +38,9 @@ admin area under the settings page:
The available required properties are: The available required properties are:
- **Service URL**: The URL to make authorization requests to - **Service URL**: The URL to make authorization requests to
- **External authorization request timeout**: The timeout after which an
authorization request is aborted. When a request times out, access is denied
to the user.
- **Default classification label**: The classification label to use when - **Default classification label**: The classification label to use when
requesting authorization if no specific label is defined on the project requesting authorization if no specific label is defined on the project
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment