File tree 2 files changed +15
-1
lines changed
x-pack/docs/en/rest-api/security
2 files changed +15
-1
lines changed Original file line number Diff line number Diff line change @@ -75,7 +75,7 @@ authentication; it will not have authority to call {es} APIs.
75
75
expire.
76
76
77
77
`metadata`::
78
- (object) Arbitrary metadata that you want to associate with the API key.
78
+ (Optional, object) Arbitrary metadata that you want to associate with the API key.
79
79
It supports nested data structure.
80
80
Within the `metadata` object, keys beginning with `_` are reserved for
81
81
system usage.
Original file line number Diff line number Diff line change @@ -73,6 +73,12 @@ intersection of API keys permissions and the permissions of the user or access
73
73
token. The structure of role descriptor is the same as the request for create
74
74
role API. For more details, see <<security-api-put-role>>.
75
75
76
+ `metadata`:::
77
+ (Optional, object) Arbitrary metadata that you want to associate with the API key.
78
+ It supports nested data structure.
79
+ Within the `metadata` object, keys beginning with `_` are reserved for
80
+ system usage.
81
+
76
82
`grant_type`::
77
83
(Required, string)
78
84
The type of grant. Supported grant types are: `access_token`,`password`.
@@ -129,6 +135,14 @@ POST /_security/api_key/grant
129
135
}
130
136
]
131
137
}
138
+ },
139
+ "metadata": {
140
+ "application": "my-application",
141
+ "environment": {
142
+ "level": 1,
143
+ "trusted": true,
144
+ "tags": ["dev", "staging"]
145
+ }
132
146
}
133
147
}
134
148
}
You can’t perform that action at this time.
0 commit comments