Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Kakulukian committed Aug 6, 2024
1 parent 324299d commit 3ef869f
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/hub/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -326,6 +326,8 @@
title: Resource Groups (Advanced Access Control)
- local: advanced-compute-options
title: Advanced Compute Options
- local: enterprise-hub-tokens-management
title: Tokens Management
- local: billing
title: Billing
- local: security
Expand Down
59 changes: 59 additions & 0 deletions docs/hub/enterprise-hub-tokens-management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Tokens Management

<Tip warning={true}>
This feature is part of the <a href="https://huggingface.co/enterprise" target="_blank">Enterprise Hub</a>.
</Tip>

Tokens Management allows organization administrators to control access tokens within their organization, ensuring that only authorized users have access to organization resources.


## Viewing and Managing Access Tokens

The token listing feature provides a view of all access tokens within your organization. Administrators can:

* Monitor token usage and identify potential security risks
* Identify inactive or unused tokens that can be revoked

<div class="flex justify-center">
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tokens-management-list.png" />
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tokens-management-list-dark.png" />
</div>


Each fine-grained token can be reviewed to see their permissions

<div class="flex justify-center">
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tokens-management-detail.png" />
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tokens-management-detail-dark.png" />
</div>


## Token policy

| **Policy** | **Personal Access Tokens Status** | **Fine-Grained Tokens Status** |
| --- | --- | --- |
| **Allow access via User Access Tokens** | Authorized | Authorized |
| **Only access via fine-grained tokens** | Unauthorized | Authorized |
| **Do not require administrator approval** | Unauthorized | Authorized |
| **Require administrator approval** | Unauthorized | Unauthorized without an approval (except for admin-created) |


<div class="flex justify-center">
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tokens-management-policy.png" />
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tokens-management-policy.png" />
</div>


## Reviewing Token Authorization

If your token policy requires an approval before accessing your resources, organization administrators can view all fine-grained tokens that can access resources owned by the organization. Organization owners can also revoke access by fine-grained personal access tokens. Organization administrators will receive an email when an authorization is requested.

When a token is revoked or denied, the user who created the token will receive an email notification.

Organization owners can only view and revoke fine-grained personal access tokens, not personal access tokens.


<div class="flex justify-center">
<img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tokens-management-review.png" />
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/tokens-management-review.png" />
</div>
3 changes: 2 additions & 1 deletion docs/hub/enterprise-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ In this section we will document the following Enterprise Hub features:
- [Storage Regions](./storage-regions)
- [Dataset viewer for Private datasets](./enterprise-hub-datasets)
- [Resource Groups](./security-resource-groups)
- [Advanced Compute Options](./advanced-compute-options)
- [Advanced Compute Options](./advanced-compute-options)
- [Tokens Management](./enterprise-hub-tokens-management)
4 changes: 4 additions & 0 deletions docs/hub/organizations-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,7 @@ You may be able to view the email addresses of members of your organization. The
<img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/org-members-page-emails-dark.png"/>
</div>


# Managing Access Tokens with access to my organization

See [Tokens Management](./enterprise-hub-tokens-management)

0 comments on commit 3ef869f

Please sign in to comment.