Skip to content

Commit

Permalink
Unauthorized route migration for routes owned by obs-ux-logs-team (el…
Browse files Browse the repository at this point in the history
…astic#198349)

### Authz API migration for unauthorized routes

This PR migrates unauthorized routes owned by your team to a new
security configuration.
Please refer to the documentation for more information: [Authorization
API](https://docs.elastic.dev/kibana-dev-docs/key-concepts/security-api-authorization)

### **Before migration:**
```ts
router.get({
  path: '/api/path',
  ...
}, handler);
```

### **After migration:**
```ts
router.get({
  path: '/api/path',
  security: {
    authz: {
      enabled: false,
      reason: 'This route is opted out from authorization because ...',
    },
  },
  ...
}, handler);
```

### What to do next?
1. Review the changes in this PR.
2. Elaborate on the reasoning to opt-out of authorization.
3. Routes without a compelling reason to opt-out of authorization should
plan to introduce them as soon as possible.
2. You might need to update your tests to reflect the new security
configuration:
  - If you have snapshot tests that include the route definition.

## Any questions?
If you have any questions or need help with API authorization, please
reach out to the `@elastic/kibana-security` team.

Co-authored-by: Elastic Machine <[email protected]>
Co-authored-by: Marco Antonio Ghiani <[email protected]>
  • Loading branch information
3 people authored Nov 12, 2024
1 parent f9e8aa0 commit 4a2de76
Showing 1 changed file with 6 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ export const initFindFieldsMetadataRoute = ({
.addVersion(
{
version: '1',
security: {
authz: {
enabled: false,
reason: 'This route is opted out from authorization',
},
},
validate: {
request: {
query: createValidationFunction(fieldsMetadataV1.findFieldsMetadataRequestQueryRT),
Expand Down

0 comments on commit 4a2de76

Please sign in to comment.