Public Role APIs #20732
There are no files selected for viewing
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
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
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 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
|
|
||
| import _ from 'lodash'; | ||
| import { wrapError } from '../../../../lib/errors'; | ||
|
|
||
| export function initDeleteRolesApi(server, callWithRequest, routePreCheckLicenseFn) { | ||
| server.route({ | ||
| method: 'DELETE', | ||
| path: '/api/security/roles/{name}', | ||
| handler(request, reply) { | ||
| const name = request.params.name; | ||
|
There was a problem hiding this comment. Edit - I'm withdrawing this comment, but leaving it here for posterity.
{"statusCode":404,"error":"Not Found","message":"Not Found"}
|
||
| return callWithRequest(request, 'shield.deleteRole', { name }).then( | ||
| () => reply().code(204), | ||
| _.flow(wrapError, reply)); | ||
| }, | ||
| config: { | ||
| pre: [routePreCheckLicenseFn] | ||
| } | ||
| }); | ||
| } | ||
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,78 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License; | ||
| * you may not use this file except in compliance with the Elastic License. | ||
| */ | ||
| import _ from 'lodash'; | ||
| import Boom from 'boom'; | ||
| import { ALL_RESOURCE } from '../../../../../common/constants'; | ||
| import { wrapError } from '../../../../lib/errors'; | ||
|
|
||
| export function initGetRolesApi(server, callWithRequest, routePreCheckLicenseFn, application) { | ||
|
|
||
| const transformKibanaApplicationsFromEs = (roleApplications) => { | ||
| return roleApplications | ||
| .filter(roleApplication => roleApplication.application === application) | ||
| .filter(roleApplication => roleApplication.resources.length > 0) | ||
| .filter(roleApplication => roleApplication.resources.every(resource => resource === ALL_RESOURCE)) | ||
| .map(roleApplication => ({ privileges: roleApplication.privileges })); | ||
| }; | ||
|
|
||
| const transformUnrecognizedApplicationsFromEs = (roleApplications) => { | ||
| return _.uniq(roleApplications | ||
| .filter(roleApplication => roleApplication.application !== application) | ||
| .map(roleApplication => roleApplication.application)); | ||
| }; | ||
|
|
||
| const transformRoleFromEs = (role, name) => { | ||
| return { | ||
| name, | ||
| metadata: role.metadata, | ||
| transient_metadata: role.transient_metadata, | ||
| elasticsearch: { | ||
| cluster: role.cluster, | ||
| indices: role.indices, | ||
| run_as: role.run_as, | ||
| }, | ||
| kibana: transformKibanaApplicationsFromEs(role.applications), | ||
| _unrecognized_applications: transformUnrecognizedApplicationsFromEs(role.applications), | ||
| }; | ||
| }; | ||
|
|
||
| const transformRolesFromEs = (roles) => { | ||
| return _.map(roles, (role, name) => transformRoleFromEs(role, name)); | ||
| }; | ||
|
|
||
| server.route({ | ||
| method: 'GET', | ||
| path: '/api/security/roles', | ||
| handler(request, reply) { | ||
| return callWithRequest(request, 'shield.getRole').then( | ||
| (response) => { | ||
| return reply(transformRolesFromEs(response)); | ||
| }, | ||
| _.flow(wrapError, reply) | ||
| ); | ||
| }, | ||
| config: { | ||
| pre: [routePreCheckLicenseFn] | ||
| } | ||
| }); | ||
|
|
||
| server.route({ | ||
| method: 'GET', | ||
| path: '/api/security/roles/{name}', | ||
| handler(request, reply) { | ||
| const name = request.params.name; | ||
| return callWithRequest(request, 'shield.getRole', { name }).then( | ||
| (response) => { | ||
| if (response[name]) return reply(transformRoleFromEs(response[name], name)); | ||
| return reply(Boom.notFound()); | ||
| }, | ||
| _.flow(wrapError, reply)); | ||
| }, | ||
| config: { | ||
| pre: [routePreCheckLicenseFn] | ||
| } | ||
| }); | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have a precedent for versioning public APIs within Kibana yet? If not, what are your thoughts on introducing a
v1prefix or similar?My concern is that, in general, these APIs will become as fluid as the current plugin API over time, with potential breaking changes within minor/patch releases.