mirror of
https://github.com/coder/coder.git
synced 2025-07-09 11:43:11 +00:00
45b53c285f
* feat: allow external services to be authable * Refactor external auth config structure for defaults * Add support for new config properties * Change the name of external auth * Move externalauth -> external-auth * Run gen * Fix tests * Fix MW tests * Fix git auth redirect * Fix lint * Fix name * Allow any ID * Fix invalid type test * Fix e2e tests * Fix comments * Fix colors * Allow accepting any type as string * Run gen * Fix href
128 lines
3.7 KiB
Markdown
Generated
128 lines
3.7 KiB
Markdown
Generated
# Git
|
|
|
|
## Get external auth by ID
|
|
|
|
### Code samples
|
|
|
|
```shell
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth} \
|
|
-H 'Accept: application/json' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /external-auth/{externalauth}`
|
|
|
|
### Parameters
|
|
|
|
| Name | In | Type | Required | Description |
|
|
| -------------- | ---- | -------------- | -------- | --------------- |
|
|
| `externalauth` | path | string(string) | true | Git Provider ID |
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"app_install_url": "string",
|
|
"app_installable": true,
|
|
"authenticated": true,
|
|
"device": true,
|
|
"display_name": "string",
|
|
"installations": [
|
|
{
|
|
"account": {
|
|
"avatar_url": "string",
|
|
"login": "string",
|
|
"name": "string",
|
|
"profile_url": "string"
|
|
},
|
|
"configure_url": "string",
|
|
"id": 0
|
|
}
|
|
],
|
|
"user": {
|
|
"avatar_url": "string",
|
|
"login": "string",
|
|
"name": "string",
|
|
"profile_url": "string"
|
|
}
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------- |
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuth](schemas.md#codersdkexternalauth) |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## Get external auth device by ID.
|
|
|
|
### Code samples
|
|
|
|
```shell
|
|
# Example request using curl
|
|
curl -X GET http://coder-server:8080/api/v2/external-auth/{externalauth}/device \
|
|
-H 'Accept: application/json' \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`GET /external-auth/{externalauth}/device`
|
|
|
|
### Parameters
|
|
|
|
| Name | In | Type | Required | Description |
|
|
| -------------- | ---- | -------------- | -------- | --------------- |
|
|
| `externalauth` | path | string(string) | true | Git Provider ID |
|
|
|
|
### Example responses
|
|
|
|
> 200 Response
|
|
|
|
```json
|
|
{
|
|
"device_code": "string",
|
|
"expires_in": 0,
|
|
"interval": 0,
|
|
"user_code": "string",
|
|
"verification_uri": "string"
|
|
}
|
|
```
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
| ------ | ------------------------------------------------------- | ----------- | -------------------------------------------------------------------- |
|
|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | [codersdk.ExternalAuthDevice](schemas.md#codersdkexternalauthdevice) |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
|
|
|
## Post external auth device by ID
|
|
|
|
### Code samples
|
|
|
|
```shell
|
|
# Example request using curl
|
|
curl -X POST http://coder-server:8080/api/v2/external-auth/{externalauth}/device \
|
|
-H 'Coder-Session-Token: API_KEY'
|
|
```
|
|
|
|
`POST /external-auth/{externalauth}/device`
|
|
|
|
### Parameters
|
|
|
|
| Name | In | Type | Required | Description |
|
|
| -------------- | ---- | -------------- | -------- | -------------------- |
|
|
| `externalauth` | path | string(string) | true | External Provider ID |
|
|
|
|
### Responses
|
|
|
|
| Status | Meaning | Description | Schema |
|
|
| ------ | --------------------------------------------------------------- | ----------- | ------ |
|
|
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | No Content | |
|
|
|
|
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|