Skip to content

Commit

Permalink
Merge pull request #63 from uc-cdis/chore/add-revoke-description-to-docs
Browse files Browse the repository at this point in the history
Chore/add revoke description to docs
  • Loading branch information
george42-ctds committed Apr 15, 2024
2 parents 6bd52ab + f5a04f6 commit e43acde
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,26 @@ authz:
```

The administrator now has access to update the status of the access request. If they approve the request, johndoe@example.com is granted access to the `dataset_D_reader` policy.

### Removing access

A user's access to a policy can be removed by creating a new request that includes the `revoke` query parameter. Submit a `POST` request to the `request` endpoint, for example:

```
POST https://mycommons.org/requestor/request?revoke
```

The body of the request should have the `username` and `policy_id`, for example

```json
{
"username": "johndoe@example.com",
"policy_id": "dataset_D_reader",
}
```

Just like access requests, revocation requests must be approved before they take effect. The user's access will be revoked when the new request has been approved by an administrator.

**IMPORTANT NOTE:** Requestor can only revoke access that has been granted through Requestor.

What does this mean? Access granted through the [user.yaml file](https://github.com/uc-cdis/fence/blob/master/docs/user.yaml_guide.md) cannot be revoked by Requestor. Similarly, removing access through the user.yaml file will not revoke access granted by Requestor.

0 comments on commit e43acde

Please sign in to comment.