Skip to content

Commit

Permalink
Backport of [docs] Convert titles to sentense case into 1.14.x (#21921)
Browse files Browse the repository at this point in the history
  • Loading branch information
averche authored Jul 18, 2023
1 parent a323e5e commit a13cf98
Show file tree
Hide file tree
Showing 593 changed files with 4,758 additions and 4,758 deletions.
30 changes: 15 additions & 15 deletions website/content/api-docs/auth/alicloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ page_title: AliCloud - Auth Methods - HTTP API
description: This is the API documentation for the Vault AliCloud auth method.
---

# AliCloud Auth Method (API)
# AliCloud auth method (API)

This is the API documentation for the Vault AliCloud auth method. For
general information about the usage and operation of the AliCloud method, please
Expand All @@ -14,7 +14,7 @@ This documentation assumes the AliCloud auth method is mounted at the `/auth/ali
path in Vault. Since it is possible to enable auth methods at any location,
please update your API calls accordingly.

## Create/Update Role
## Create/Update role

Registers a role. Only entities using the role registered using this endpoint
will be able to perform the login operation.
Expand All @@ -30,7 +30,7 @@ will be able to perform the login operation.

@include 'tokenfields.mdx'

### Sample Payload
### Sample payload

```json
{
Expand All @@ -39,7 +39,7 @@ will be able to perform the login operation.
}
```

### Sample Request
### Sample request

```shell-session
$ curl \
Expand All @@ -49,7 +49,7 @@ $ curl \
http://127.0.0.1:8200/v1/auth/alicloud/role/dev-role
```

## Read Role
## Read role

Returns the previously registered role configuration.

Expand All @@ -61,15 +61,15 @@ Returns the previously registered role configuration.

- `role` `(string: <required>)` - Name of the role.

### Sample Request
### Sample request

```shell-session
$ curl \
--header "X-Vault-Token: ..." \
http://127.0.0.1:8200/v1/auth/alicloud/role/dev-role
```

### Sample Response
### Sample response

```json
{
Expand All @@ -83,15 +83,15 @@ $ curl \
}
```

## List Roles
## List roles

Lists all the roles that are registered with the method.

| Method | Path |
| :----- | :--------------------- |
| `LIST` | `/auth/alicloud/roles` |

### Sample Request
### Sample request

```shell-session
$ curl \
Expand All @@ -100,7 +100,7 @@ $ curl \
http://127.0.0.1:8200/v1/auth/alicloud/roles
```

### Sample Response
### Sample response

```json
{
Expand All @@ -110,7 +110,7 @@ $ curl \
}
```

## Delete Role
## Delete role

Deletes the previously registered role.

Expand All @@ -122,7 +122,7 @@ Deletes the previously registered role.

- `role` `(string: <required>)` - Name of the role.

### Sample Request
### Sample request

```shell-session
$ curl \
Expand Down Expand Up @@ -151,7 +151,7 @@ GetCallerIdentity request.
string value or an array of string values (though the length of that array
will probably only be one).

### Sample Payload
### Sample payload

```json
{
Expand All @@ -161,7 +161,7 @@ GetCallerIdentity request.
}
```

### Sample Request
### Sample request

```shell-session
$ curl \
Expand All @@ -170,7 +170,7 @@ $ curl \
http://127.0.0.1:8200/v1/auth/alicloud/login
```

### Sample Response
### Sample response

```json
{
Expand Down
Loading

0 comments on commit a13cf98

Please sign in to comment.