API Docs updates (#3135)
This commit is contained in:
Chris Hoffman
GitHub
parent
d8a3bccb43
commit
e3e5be4617
|
|
@ -14,4 +14,127 @@ see the [Vault Github backend documentation](/docs/auth/github.html).
|
|||
|
||||
This documentation assumes the Github backend is mounted at the `/auth/github`
|
||||
path in Vault. Since it is possible to mount auth backends at any location,
|
||||
please update your API calls accordingly.
|
||||
please update your API calls accordingly.
|
||||
|
||||
## Configure Backend
|
||||
|
||||
Configures the connection parameters for Okta. This path honors the
|
||||
distinction between the `create` and `update` capabilities inside ACL policies.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `POST` | `/auth/github/config` | `204 (empty body)` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `organization` `(string: <required>)` - The organization users must be part
|
||||
of.
|
||||
- `base_url` `(string: "")` - The API endpoint to use. Useful if you are running
|
||||
GitHub Enterprise or an API-compatible authentication server.
|
||||
- `ttl` `(string: "")` - Duration after which authentication will be expired.
|
||||
- `max_ttl` `(string: "")` - Maximum duration after which authentication will
|
||||
be expired.
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
{
|
||||
"organization": "acme-org"
|
||||
}
|
||||
```
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
--request POST \
|
||||
--data @payload.json \
|
||||
https://vault.rocks/v1/auth/githubokta/config
|
||||
```
|
||||
|
||||
## Read Configuration
|
||||
|
||||
Reads the Okta configuration.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `GET` | `/auth/github/config` | `200 application/json` |
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
https://vault.rocks/v1/auth/github/config
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```json
|
||||
{
|
||||
"request_id": "812229d7-a82e-0b20-c35b-81ce8c1b9fa6",
|
||||
"lease_id": "",
|
||||
"lease_duration": 0,
|
||||
"renewable": false,
|
||||
"data": {
|
||||
"organization": "acme-org",
|
||||
"base_url": "",
|
||||
"ttl": "",
|
||||
"max_ttl": ""
|
||||
},
|
||||
"warnings": null
|
||||
}
|
||||
```
|
||||
|
||||
## Login
|
||||
|
||||
Login using GitHub access token.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `POST` | `/auth/github/login` | `200 application/json` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `token` `(string: <required>)` - GitHub personal API token.
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
{
|
||||
"token": "ABC123..."
|
||||
}
|
||||
```
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
--request POST \
|
||||
https://vault.rocks/v1/auth/github/login
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```javascript
|
||||
{
|
||||
"lease_id": "",
|
||||
"renewable": false,
|
||||
"lease_duration": 0,
|
||||
"data": null,
|
||||
"warnings": null,
|
||||
"auth": {
|
||||
"client_token": "64d2a8f2-2a2f-5688-102b-e6088b76e344",
|
||||
"accessor": "18bb8f89-826a-56ee-c65b-1736dc5ea27d",
|
||||
"policies": ["default"],
|
||||
"metadata": {
|
||||
"username": "fred",
|
||||
"org": "acme-org"
|
||||
},
|
||||
},
|
||||
"lease_duration": 7200,
|
||||
"renewable": true
|
||||
}
|
||||
```
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
---
|
||||
layout: "api"
|
||||
page_title: "MFA Auth Backend - HTTP API"
|
||||
sidebar_current: "docs-http-auth-mfa"
|
||||
description: |-
|
||||
This is the API documentation for the Vault MFA authentication backend.
|
||||
---
|
||||
|
||||
# MFA Auth Backend HTTP API
|
||||
|
||||
This is the API documentation for the Vault MFA authentication backend. For
|
||||
general information about the usage and operation of the AppRole backend, please
|
||||
see the [Vault MFA backend documentation](/docs/auth/mfa.html).
|
||||
|
||||
This documentation assumes the MFA backend is mounted at the `/auth/mfa`
|
||||
path in Vault. Since it is possible to mount auth backends at any location,
|
||||
please update your API calls accordingly.
|
||||
|
|
@ -14,4 +14,378 @@ see the [Vault Okta backend documentation](/docs/auth/okta.html).
|
|||
|
||||
This documentation assumes the Okta backend is mounted at the `/auth/okta`
|
||||
path in Vault. Since it is possible to mount auth backends at any location,
|
||||
please update your API calls accordingly.
|
||||
please update your API calls accordingly.
|
||||
|
||||
## Create Configuration
|
||||
|
||||
Configures the connection parameters for Okta. This path honors the
|
||||
distinction between the `create` and `update` capabilities inside ACL policies.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `POST` | `/auth/okta/config` | `204 (empty body)` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `organization` `(string: <required>)` - Okta organization to authenticate
|
||||
against.
|
||||
- `token` `(string: "")` - Okta admin API token.
|
||||
- `base_url` `(string: "")` - The API endpoint to use. Useful if you are using
|
||||
Okta development accounts.
|
||||
- `ttl` `(string: "")` - Duration after which authentication will be expired.
|
||||
- `max_ttl` `(string: "")` - Maximum duration after which authentication will
|
||||
be expired.
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
{
|
||||
"organization": "example",
|
||||
"token": "abc123"
|
||||
}
|
||||
```
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
--request POST \
|
||||
--data @payload.json \
|
||||
https://vault.rocks/v1/auth/okta/config
|
||||
```
|
||||
|
||||
## Read Configuration
|
||||
|
||||
Reads the Okta configuration.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `GET` | `/auth/okta/config` | `200 application/json` |
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
https://vault.rocks/v1/auth/okta/config
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```json
|
||||
{
|
||||
"request_id": "812229d7-a82e-0b20-c35b-81ce8c1b9fa6",
|
||||
"lease_id": "",
|
||||
"lease_duration": 0,
|
||||
"renewable": false,
|
||||
"data": {
|
||||
"organization": "example",
|
||||
"token": "abc123",
|
||||
"base_url": "",
|
||||
"ttl": "",
|
||||
"max_ttl": ""
|
||||
},
|
||||
"warnings": null
|
||||
}
|
||||
```
|
||||
|
||||
## List Users
|
||||
|
||||
List the users configurated in the Okta backend.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `LIST` | `/auth/okta/users` | `200 application/json` |
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
--request LIST \
|
||||
https://vault.rocks/v1/auth/okta/users
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```json
|
||||
{
|
||||
"auth": null,
|
||||
"warnings": null,
|
||||
"wrap_info": null,
|
||||
"data": {
|
||||
"keys": [
|
||||
"fred",
|
||||
"jane"
|
||||
]
|
||||
},
|
||||
"lease_duration": 0,
|
||||
"renewable": false,
|
||||
"lease_id": ""
|
||||
}
|
||||
```
|
||||
|
||||
## Register User
|
||||
|
||||
Registers a new user and maps a set of policies to it.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `POST` | `/auth/okta/users/:username` | `204 (empty body)` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `username` `(string: <required>)` - Name of the user.
|
||||
- `groups` `(string: "")` - Comma-separated list of groups associated with the
|
||||
user.
|
||||
- `policies` `(string: "")` - Comma-separated list of policies associated with
|
||||
the user.
|
||||
|
||||
```json
|
||||
{
|
||||
"policies": "dev,prod",
|
||||
}
|
||||
```
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
--request POST \
|
||||
--data @payload.json \
|
||||
https://vault.rocks/v1/auth/okta/users/fred
|
||||
```
|
||||
|
||||
## Read User
|
||||
|
||||
Reads the properties of an existing username.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `GET` | `/auth/okta/users/:username` | `200 application/json` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `username` `(string: <required>)` - Username for this user.
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
https://vault.rocks/v1/auth/okta/users/test-user
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```json
|
||||
{
|
||||
"request_id": "812229d7-a82e-0b20-c35b-81ce8c1b9fa6",
|
||||
"lease_id": "",
|
||||
"lease_duration": 0,
|
||||
"renewable": false,
|
||||
"data": {
|
||||
"policies": "default,dev",
|
||||
"groups": ""
|
||||
},
|
||||
"warnings": null
|
||||
}
|
||||
```
|
||||
|
||||
## Delete User
|
||||
|
||||
Deletes an existing username from the backend.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `DELETE` | `/auth/okta/users/:username` | `204 (empty body)` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `username` `(string: <required>)` - Username for this user.
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
--request DELETE \
|
||||
https://vault.rocks/v1/auth/okta/users/test-user
|
||||
```
|
||||
|
||||
## List Groups
|
||||
|
||||
List the groups configurated in the Okta backend.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `LIST` | `/auth/okta/groups` | `200 application/json` |
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
--request LIST \
|
||||
https://vault.rocks/v1/auth/okta/groups
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```json
|
||||
{
|
||||
"auth": null,
|
||||
"warnings": null,
|
||||
"wrap_info": null,
|
||||
"data": {
|
||||
"keys": [
|
||||
"admins",
|
||||
"dev-users"
|
||||
]
|
||||
},
|
||||
"lease_duration": 0,
|
||||
"renewable": false,
|
||||
"lease_id": ""
|
||||
}
|
||||
```
|
||||
|
||||
## Register Group
|
||||
|
||||
Registers a new group and maps a set of policies to it.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `POST` | `/auth/okta/groups/:name` | `204 (empty body)` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `name` `(string: <required>)` - The name of the group.
|
||||
- `policies` `(string: "")` - Comma-separated list of policies associated with
|
||||
the group.
|
||||
|
||||
```json
|
||||
{
|
||||
"policies": "dev,prod",
|
||||
}
|
||||
```
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
--request POST \
|
||||
--data @payload.json \
|
||||
https://vault.rocks/v1/auth/okta/groups/admins
|
||||
```
|
||||
|
||||
## Read Group
|
||||
|
||||
Reads the properties of an existing group.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `GET` | `/auth/okta/groups/:name` | `200 application/json` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `name` `(string: <required>)` - The name for the group.
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
https://vault.rocks/v1/auth/okta/groups/admins
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```json
|
||||
{
|
||||
"request_id": "812229d7-a82e-0b20-c35b-81ce8c1b9fa6",
|
||||
"lease_id": "",
|
||||
"lease_duration": 0,
|
||||
"renewable": false,
|
||||
"data": {
|
||||
"policies": "default,admin"
|
||||
},
|
||||
"warnings": null
|
||||
}
|
||||
```
|
||||
|
||||
## Delete Group
|
||||
|
||||
Deletes an existing group from the backend.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `DELETE` | `/auth/okta/groups/:name` | `204 (empty body)` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `name` `(string: <required>)` - The name for the group.
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
--request DELETE \
|
||||
https://vault.rocks/v1/auth/okta/users/test-user
|
||||
```
|
||||
|
||||
## Login
|
||||
|
||||
Login with the username and password.
|
||||
|
||||
| Method | Path | Produces |
|
||||
| :------- | :--------------------------- | :--------------------- |
|
||||
| `POST` | `/auth/okta/login/:username` | `200 application/json` |
|
||||
|
||||
### Parameters
|
||||
|
||||
- `username` `(string: <required>)` - Username for this user.
|
||||
- `password` `(string: <required>)` - Password for the autheticating user.
|
||||
|
||||
### Sample Payload
|
||||
|
||||
```json
|
||||
{
|
||||
"password": "Password!"
|
||||
}
|
||||
```
|
||||
|
||||
### Sample Request
|
||||
|
||||
```
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
--request POST \
|
||||
https://vault.rocks/v1/auth/okta/login/fred
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```javascript
|
||||
{
|
||||
"lease_id": "",
|
||||
"renewable": false,
|
||||
"lease_duration": 0,
|
||||
"data": null,
|
||||
"warnings": null,
|
||||
"auth": {
|
||||
"client_token": "64d2a8f2-2a2f-5688-102b-e6088b76e344",
|
||||
"accessor": "18bb8f89-826a-56ee-c65b-1736dc5ea27d",
|
||||
"policies": ["default"],
|
||||
"metadata": {
|
||||
"username": "fred",
|
||||
"policies": "default"
|
||||
},
|
||||
},
|
||||
"lease_duration": 7200,
|
||||
"renewable": true
|
||||
}
|
||||
```
|
||||
|
|
@ -18,7 +18,7 @@ please update your API calls accordingly.
|
|||
|
||||
## Configure RADIUS
|
||||
|
||||
Configures the connection parameters and shard secret used to communicate with
|
||||
Configures the connection parameters and shared secret used to communicate with
|
||||
RADIUS.
|
||||
|
||||
| Method | Path | Produces |
|
||||
|
|
@ -114,7 +114,7 @@ $ curl \
|
|||
|
||||
### Sample Response
|
||||
|
||||
```javascript
|
||||
```json
|
||||
{
|
||||
"request_id": "812229d7-a82e-0b20-c35b-81ce8c1b9fa6",
|
||||
"lease_id": "",
|
||||
|
|
|
|||
|
|
@ -159,3 +159,9 @@ token_policies: [default dev-policy]
|
|||
|
||||
Clients can use this token to perform an allowed set of operations on all the
|
||||
paths contained by the policy set.
|
||||
|
||||
## API
|
||||
|
||||
The GitHub authentication backend has a full HTTP API. Please see the
|
||||
[GitHub Auth API](/api/auth/github/index.html) for more
|
||||
details.
|
||||
|
|
@ -161,3 +161,9 @@ Groups can only be pulled from Okta if an API token is configured via `token`
|
|||
## Note on policy mapping
|
||||
|
||||
It should be noted that user -> policy mapping (via group membership) happens at token creation time. And changes in group membership in Okta will not affect tokens that have already been provisioned. To see these changes, old tokens should be revoked and the user should be asked to reauthenticate.
|
||||
|
||||
## API
|
||||
|
||||
The Okta authentication backend has a full HTTP API. Please see the
|
||||
[Okta Auth API](/api/auth/okta/index.html) for more
|
||||
details.
|
||||
|
|
@ -101,9 +101,6 @@
|
|||
<li<%= sidebar_current("docs-http-auth-ldap") %>>
|
||||
<a href="/api/auth/ldap/index.html">LDAP</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-http-auth-mfa") %>>
|
||||
<a href="/api/auth/mfa/index.html">MFA</a>
|
||||
</li>
|
||||
<li<%= sidebar_current("docs-http-auth-okta") %>>
|
||||
<a href="/api/auth/okta/index.html">Okta</a>
|
||||
</li>
|
||||
|
|
|
|||
Loading…
Reference in New Issue