UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

164 lines (75 loc) 2.58 kB
--- lang: en title: 'API docs: authorization.authorizationmetadata' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/authorization permalink: /doc/en/lb4/apidocs.authorization.authorizationmetadata.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/authorization](./authorization.md) &gt; [AuthorizationMetadata](./authorization.authorizationmetadata.md) ## AuthorizationMetadata interface Authorization metadata supplied via `@authorize` decorator **Signature:** ```typescript export interface AuthorizationMetadata ``` ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [allowedRoles?](./authorization.authorizationmetadata.allowedroles.md) </td><td markdown="1"> </td><td markdown="1"> string\[\] </td><td markdown="1"> _(Optional)_ Roles that are allowed access </td></tr> <tr><td markdown="1"> [deniedRoles?](./authorization.authorizationmetadata.deniedroles.md) </td><td markdown="1"> </td><td markdown="1"> string\[\] </td><td markdown="1"> _(Optional)_ Roles that are denied access </td></tr> <tr><td markdown="1"> [resource?](./authorization.authorizationmetadata.resource.md) </td><td markdown="1"> </td><td markdown="1"> string </td><td markdown="1"> _(Optional)_ Name of the resource, default to the method name </td></tr> <tr><td markdown="1"> [scopes?](./authorization.authorizationmetadata.scopes.md) </td><td markdown="1"> </td><td markdown="1"> string\[\] </td><td markdown="1"> _(Optional)_ Define the access scopes </td></tr> <tr><td markdown="1"> [skip?](./authorization.authorizationmetadata.skip.md) </td><td markdown="1"> </td><td markdown="1"> boolean </td><td markdown="1"> _(Optional)_ A flag to skip authorization </td></tr> <tr><td markdown="1"> [voters?](./authorization.authorizationmetadata.voters.md) </td><td markdown="1"> </td><td markdown="1"> ([Authorizer](./authorization.authorizer.md) \| [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;[Authorizer](./authorization.authorizer.md)<!-- -->&gt;)\[\] </td><td markdown="1"> _(Optional)_ Voters that help make the authorization decision </td></tr> </tbody></table>