Skip to content

Commit

Permalink
docs: update links surrounding the authorization component documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Hector Leiva <hector@hectorleiva.com>
  • Loading branch information
hectorleiva authored and dhmlau committed Dec 7, 2020
1 parent fa8e6d7 commit 562233c
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/site/Authorization-component-decision-matrix.md
Expand Up @@ -31,6 +31,6 @@ corresponding options.
- if the `authorizer` function returns `ALLOW`, but voter 1 in authorize
decorator returns `ABSTAIN` and voter 2 in decorator returns `DENY`.
- In this case, if the options provided while
[registering the authorization component](#authorization-component),
[registering the authorization component](Authorization-component.md),
provides precedence as `DENY`, then the access for the subject is denied to
the endpoint.
2 changes: 1 addition & 1 deletion docs/site/Authorization-component-interceptor.md
Expand Up @@ -18,4 +18,4 @@ The `Authorization interceptor` enforces authorization with user-provided
collects `voters` provided in the `@authorize` decorator of the endpoint.
- It executes each of the above collected functions provided by the user.
- Based on the result of all functions it enforces access/privilege control
using [a decision matrix](#authorization-by-decision-matrix).
using [a decision matrix](Authorization-component-decision-matrix.md).
6 changes: 3 additions & 3 deletions docs/site/Authorization-component.md
Expand Up @@ -26,9 +26,9 @@ class.
```

- The authorization `options` are provided specifically for enforcing the
[decision matrix](#authorization-by-decision-matrix), which is used to combine
voters from all `authorize` functions. The options are described per the
interface AuthorizationOptions.
[decision matrix](Authorization-component-decision-matrix.md), which is used
to combine voters from all `authorize` functions. The options are described
per the interface AuthorizationOptions.

```ts
export interface AuthorizationOptions {
Expand Down
5 changes: 2 additions & 3 deletions docs/site/Authorization-overview.md
Expand Up @@ -30,9 +30,8 @@ by the users.
A `Principal` could be a User, Application or Device. The `Principal` is
identified from the credential provided by a client, by the configured
`Authentication strategy` of the endpoint
([see, LoopBack Authentication](https://loopback.io/doc/en/lb4/Loopback-component-authentication.html)).
Access rights of the client is either associated with or included in the
credential.
([see, LoopBack Authentication](Loopback-component-authentication.md)). Access
rights of the client is either associated with or included in the credential.

The `Principal` is then used by LoopBack's authorization mechanism to enforce
necessary privileges/access rights by using the permissions annotated by the
Expand Down

0 comments on commit 562233c

Please sign in to comment.