Skip to content

Commit 0756494

Browse files
committed
[DOCS] Identifies required and optional parameters
1 parent 4ea6862 commit 0756494

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

x-pack/docs/en/rest-api/security/get-tokens.asciidoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,27 +77,27 @@ This grant type implements the Refresh Token Grant of OAuth2.
7777
In this grant a user exchanges a previously issued refresh token for a new access token and a new refresh token.
7878

7979
`password`::
80-
(string) The user's password. If you specify the `password` grant type, this
80+
(Optional^*^, string) The user's password. If you specify the `password` grant type, this
8181
parameter is required. This parameter is not valid with any other supported
8282
grant type.
8383

8484
`kerberos_ticket`::
85-
(string) base64 encoded kerberos ticket. If you specify the `_kerberos` grant type,
86-
this parameter is required. This parameter is not valid with any other supported
87-
grant type.
85+
(Optional^*^, string) The base64 encoded kerberos ticket. If you specify the
86+
`_kerberos` grant type, this parameter is required. This parameter is not valid
87+
with any other supported grant type.
8888

8989
`refresh_token`::
90-
(string) If you specify the `refresh_token` grant type, this parameter is
91-
required. It contains the string that was returned when you created the token
92-
and enables you to extend its life. This parameter is not valid with any other
90+
(Optional^*^, string) The string that was returned when you created the token,
91+
which enables you to extend its life. If you specify the `refresh_token` grant
92+
type, this parameter is required. This parameter is not valid with any other
9393
supported grant type.
9494

9595
`scope`::
96-
(string) The scope of the token. Currently tokens are only issued for a scope of
96+
(Optional, string) The scope of the token. Currently tokens are only issued for a scope of
9797
`FULL` regardless of the value sent with the request.
9898

9999
`username`::
100-
(string) The username that identifies the user. If you specify the `password`
100+
(Optional^*^, string) The username that identifies the user. If you specify the `password`
101101
grant type, this parameter is required. This parameter is not valid with any
102102
other supported grant type.
103103

0 commit comments

Comments
 (0)