resource-groups

Invite external user

Changed on

Invite a user who is not yet an organization member into a resource group. On accepting, they only get access to that resource group, with the requested read or write role.

Requires external invites to be enabled in the organization's resource group settings, unless the caller is an organization admin.

post/api/organizations/{name}/resource-groups/{resourceGroupId}/invite

Request

  • Base URL: https://huggingface.co
  • URL: https://huggingface.co/api/organizations/{name}/resource-groups/{resourceGroupId}/invite
  • Auth: HTTP bearer

Path parameters

namestring required
resourceGroupIdstring required

Request body

usernamestring required

Username of an existing Hugging Face user

role'read' | 'write' required

Role the invitee gets inside the resource group

Response

The created invitation

idstring required

A hex string of 24 characters representing an ObjectId.

role'admin' | 'write' | 'contributor' | 'read' | 'no_access' required

Organization role the invitee joins with

externalCollaboratorboolean

Whether the invitee is exempted from SSO enforcement

expiresAtstring date-time required

Changes