-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
154 changed files
with
2,705 additions
and
115 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
specification/security/activate_user_profile/examples/request/RequestExample1.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# summary: | ||
# method_request: POST /_security/user/jacknich | ||
description: > | ||
Run `POST /_security/user/jacknich` to create a user. | ||
# type: request | ||
value: |- | ||
{ | ||
"password" : "l0ng-r4nd0m-p@ssw0rd", | ||
"roles" : [ "admin", "other_role1" ], | ||
"full_name" : "Jack Nicholson", | ||
"email" : "jacknich@example.com", | ||
"metadata" : { | ||
"intelligence" : 7 | ||
} | ||
} |
25 changes: 25 additions & 0 deletions
25
specification/security/activate_user_profile/examples/response/ResponseExample1.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# summary: | ||
description: A successful response from `POST /_security/profile/_activate`. | ||
# type: response | ||
# response_code: | ||
value: |- | ||
{ | ||
"uid": "u_79HkWkwmnBH5gqFKwoxggWPjEBOur1zLPXQPEl1VBW0_0", | ||
"enabled": true, | ||
"last_synchronized": 1642650651037, | ||
"user": { | ||
"username": "jacknich", | ||
"roles": [ | ||
"admin", "other_role1" | ||
], | ||
"realm_name": "native", | ||
"full_name": "Jack Nicholson", | ||
"email": "jacknich@example.com" | ||
}, | ||
"labels": {}, | ||
"data": {}, | ||
"_doc": { | ||
"_primary_term": 88, | ||
"_seq_no": 66 | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
...ication/security/authenticate/examples/response/SecurityAuthenticateResponseExample1.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# summary: | ||
description: A successful response from `GET /_security/_authenticate`. | ||
# type: response | ||
# response_code: 200 | ||
value: |- | ||
{ | ||
"username": "rdeniro", | ||
"roles": [ | ||
"admin" | ||
], | ||
"full_name": null, | ||
"email": null, | ||
"metadata": { }, | ||
"enabled": true, | ||
"authentication_realm": { | ||
"name" : "file", | ||
"type" : "file" | ||
}, | ||
"lookup_realm": { | ||
"name" : "file", | ||
"type" : "file" | ||
}, | ||
"authentication_type": "realm" | ||
} |
9 changes: 9 additions & 0 deletions
9
...ion/security/bulk_delete_role/examples/request/SecurityBulkDeleteRoleRequestExample1.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
summary: Bulk delete example 1 | ||
# method_request: DELETE /_security/role | ||
description: > | ||
Run DELETE /_security/role` to delete `my_admin_role` and `my_user_role` roles. | ||
# type: request | ||
value: |- | ||
{ | ||
"names": ["my_admin_role", "my_user_role"] | ||
} |
11 changes: 11 additions & 0 deletions
11
...n/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample1.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
summary: A successful response | ||
description: A successful response from `DELETE /_security/role`. | ||
# type: response | ||
# response_code: | ||
value: |- | ||
{ | ||
"deleted": [ | ||
"my_admin_role", | ||
"my_user_role" | ||
] | ||
} |
15 changes: 15 additions & 0 deletions
15
...n/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample2.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
summary: A response with not_found roles | ||
description: > | ||
A partially successful response from `DELETE /_security/role`. | ||
If a role cannot be found, it appears in the `not_found` list in the response. | ||
# type: response | ||
# response_code: | ||
value: |- | ||
{ | ||
"deleted": [ | ||
"my_admin_role" | ||
], | ||
"not_found": [ | ||
"not_an_existing_role" | ||
] | ||
} |
21 changes: 21 additions & 0 deletions
21
...n/security/bulk_delete_role/examples/response/SecurityBulkDeleteRoleResponseExample3.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
summary: A response with errors | ||
description: > | ||
A partially successful response from `DELETE /_security/role`. | ||
If part of a request fails or is invalid, the response includes `errors`. | ||
# type: response | ||
# response_code: | ||
value: |- | ||
{ | ||
"deleted": [ | ||
"my_admin_role" | ||
], | ||
"errors": { | ||
"count": 1, | ||
"details": { | ||
"superuser": { | ||
"type": "illegal_argument_exception", | ||
"reason": "role [superuser] is reserved and cannot be deleted" | ||
} | ||
} | ||
} | ||
} |
91 changes: 91 additions & 0 deletions
91
...ification/security/bulk_put_role/examples/request/SecurityBulkPutRoleRequestExample1.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
summary: Bulk role success | ||
# method_request: POST /_security/role | ||
description: > | ||
Run `POST /_security/role` to add roles called `my_admin_role` and `my_user_role`. | ||
# type: request | ||
value: |- | ||
{ | ||
"roles": { | ||
"my_admin_role": { | ||
"cluster": [ | ||
"all" | ||
], | ||
"indices": [ | ||
{ | ||
"names": [ | ||
"index1", | ||
"index2" | ||
], | ||
"privileges": [ | ||
"all" | ||
], | ||
"field_security": { | ||
"grant": [ | ||
"title", | ||
"body" | ||
] | ||
}, | ||
"query": "{\"match\": {\"title\": \"foo\"}}" | ||
} | ||
], | ||
"applications": [ | ||
{ | ||
"application": "myapp", | ||
"privileges": [ | ||
"admin", | ||
"read" | ||
], | ||
"resources": [ | ||
"*" | ||
] | ||
} | ||
], | ||
"run_as": [ | ||
"other_user" | ||
], | ||
"metadata": { | ||
"version": 1 | ||
} | ||
}, | ||
"my_user_role": { | ||
"cluster": [ | ||
"all" | ||
], | ||
"indices": [ | ||
{ | ||
"names": [ | ||
"index1" | ||
], | ||
"privileges": [ | ||
"read" | ||
], | ||
"field_security": { | ||
"grant": [ | ||
"title", | ||
"body" | ||
] | ||
}, | ||
"query": "{\"match\": {\"title\": \"foo\"}}" | ||
} | ||
], | ||
"applications": [ | ||
{ | ||
"application": "myapp", | ||
"privileges": [ | ||
"admin", | ||
"read" | ||
], | ||
"resources": [ | ||
"*" | ||
] | ||
} | ||
], | ||
"run_as": [ | ||
"other_user" | ||
], | ||
"metadata": { | ||
"version": 1 | ||
} | ||
} | ||
} | ||
} |
Oops, something went wrong.