# Platform

Learn how to manage your Buddy account, workspace, projects, members, groups, permissions, SSO, and OIDC.

## Contents

- [Account management](/docs/api/platform/account.md) - Learn more about managing your user profile in Buddy.
  - [Get user](/docs/api/platform/account/get.md) - Returns the details of the authorized user
  - [Update user](/docs/api/platform/account/update.md) - Updates the authorized user
  - [Emails](/docs/api/platform/account/emails.md) - Learn how to add, delete and list user e-mail addresses in Buddy.
    - [List Emails](/docs/api/platform/account/emails/list.md) - Get user's email addresses
    - [Add Emails](/docs/api/platform/account/emails/add.md) - Add email address to user account
    - [Delete Emails](/docs/api/platform/account/emails/delete.md) - Delete an email address
  - [Personal Access Tokens](/docs/api/platform/account/personal-access-tokens.md) - Learn how to add, delete and list personal access tokens in Buddy.
    - [Get](/docs/api/platform/account/personal-access-tokens/get.md) - Learn how to get a personal access token in Buddy.
      - [Get current token](/docs/api/platform/account/personal-access-tokens/get/current-token.md) - Get personal access token used for authorization
      - [Get token by ID](/docs/api/platform/account/personal-access-tokens/get/by-id.md) - Get personal access token by ID
    - [List Personal Access Tokens](/docs/api/platform/account/personal-access-tokens/list.md) - Get list of personal access tokens
    - [Add Personal Access Tokens](/docs/api/platform/account/personal-access-tokens/add.md) - Add personal access token
    - [Delete Personal Access Tokens](/docs/api/platform/account/personal-access-tokens/delete.md) - Delete personal access token
  - [SSH keys](/docs/api/platform/account/ssh-keys.md) - Learn how to create, delete and manage your SSH keys in Buddy.
    - [Edit](/docs/api/platform/account/ssh-keys/edit.md) - Can you remove, update or edit public SSH key in Buddy?
    - [List SSH keys](/docs/api/platform/account/ssh-keys/list.md) - Get user's SSH keys
    - [Add SSH keys](/docs/api/platform/account/ssh-keys/add.md) - Registers a new public SSH key for the authorized user
    - [Get SSH keys](/docs/api/platform/account/ssh-keys/get.md) - Returns the public SSH key of the authorized user
    - [Delete SSH keys](/docs/api/platform/account/ssh-keys/delete.md) - Deletes a public SSH key of the authorized user
- [Projects](/docs/api/platform/projects.md) - Learn more how to manage projects in Buddy
  - [Get](/docs/api/platform/projects/get.md) - Learn how to get project data, information about a project member, or information about a group in the project.
    - [Repository contents](/docs/api/platform/projects/get/repository-contents.md) - Returns the contents of the repository for the specified revision or HEAD
    - [Group](/docs/api/platform/projects/get/group.md) - Returns a single user group in the specified project
    - [Member](/docs/api/platform/projects/get/member.md) - Get a specific project member by ID
    - [Project](/docs/api/platform/projects/get/project.md) - Get a specific project by name
  - [List](/docs/api/platform/projects/list.md) - Learn how to list all projects in a workspace, all members of a project, and all groups in a project.
    - [Groups](/docs/api/platform/projects/list/groups.md) - Lists all groups assigned to the specified project. The authorized user must have admin rights in the project to get the information about permissions in that project
    - [Members](/docs/api/platform/projects/list/members.md) - Get all members in the project
    - [Projects](/docs/api/platform/projects/list/projects.md) - Get all projects in the workspace
  - [Manage access](/docs/api/platform/projects/manage-access.md) - Learn more how to manage project members and access in projects.
    - [Add](/docs/api/platform/projects/manage-access/add.md) - Learn how to add members and groups to your Buddy project.
      - [Group](/docs/api/platform/projects/manage-access/add/group.md) - Assign a group to the project
      - [Member](/docs/api/platform/projects/manage-access/add/member.md) - Add a new member to the project
    - [Update](/docs/api/platform/projects/manage-access/update.md) - Learn how to update permission sets of user and groups in Buddy projects.
      - [Group](/docs/api/platform/projects/manage-access/update/group.md) - Update project group permissions
      - [Member](/docs/api/platform/projects/manage-access/update/member.md) - Update project member permissions
    - [Delete](/docs/api/platform/projects/manage-access/delete.md) - Learn how to delete users and user groups from projects.
      - [Group](/docs/api/platform/projects/manage-access/delete/group.md) - Remove a group from the project
      - [Member](/docs/api/platform/projects/manage-access/delete/member.md) - Remove a member from the project
  - [Create Projects](/docs/api/platform/projects/create.md) - Create a new project
  - [Edit Projects](/docs/api/platform/projects/edit.md) - Update project configuration
  - [Delete Projects](/docs/api/platform/projects/delete.md) - Delete a project
- [Groups](/docs/api/platform/groups.md) - Learn how to create, delete, edit and manage groups in Buddy.
  - [Get](/docs/api/platform/groups/get.md) - Learn how to get details of a single user group or a single group member in Buddy.
    - [Group Member](/docs/api/platform/groups/get/group-member.md) - Returns a single member of a user group
    - [User group](/docs/api/platform/groups/get/user-group.md) - Shows details of an user group
  - [List](/docs/api/platform/groups/list.md) - Learn how to list user groups and all members in a user group in Buddy.
    - [Group Members](/docs/api/platform/groups/list/group-members.md) - Returns all members from the group
    - [User groups](/docs/api/platform/groups/list/user-groups.md) - Returns all groups in the workspace
  - [Edit](/docs/api/platform/groups/edit.md) - Learn how to edit groups or a group member's status in Buddy.
    - [Group Member](/docs/api/platform/groups/edit/group-member.md) - Updates the group member's status
    - [User group](/docs/api/platform/groups/edit/user-group.md) - Edits the properties of an existing group
  - [Delete](/docs/api/platform/groups/delete.md) - Learn how to delete groups and group members.
    - [Group member](/docs/api/platform/groups/delete/group-member.md) - Deletes a member from a group
    - [User Group](/docs/api/platform/groups/delete/user-group.md) - Deletes a group
  - [Add users to group](/docs/api/platform/groups/add.md) - Adds a user to the group
  - [Create Groups](/docs/api/platform/groups/create.md) - Creates a new group. Restricted to admins only
- [Members](/docs/api/platform/members.md) - Learn how to manage members of your Buddy workspace.
  - [List](/docs/api/platform/members/list.md) - Learn how to list workspace members and user projects in Buddy.
    - [User Projects](/docs/api/platform/members/list/user-projects.md) - Get all projects accessible to a workspace member
    - [Workspace Members](/docs/api/platform/members/list/workspace-members.md) - Get all members in the workspace
  - [Add Members](/docs/api/platform/members/add.md) - Add a new member to the workspace
  - [Get Members](/docs/api/platform/members/get.md) - Get a specific workspace member by ID
  - [Update](/docs/api/platform/members/update.md) - Update workspace member configuration
  - [Delete Members](/docs/api/platform/members/delete.md) - Remove a member from the workspace
- [Permissions](/docs/api/platform/permissions.md) - Learn how to manage permission sets in Buddy.
  - [Get](/docs/api/platform/permissions/get.md) - Learn how to get details of custom permission sets in Buddy.
    - [Permission sets in a workspace](/docs/api/platform/permissions/get/workspace-permission.md) - Get details of custom permission sets in a workspace
    - [Single custom permission set](/docs/api/platform/permissions/get/custom-permission.md) - Get details of single custom permission set
  - [Create Permissions](/docs/api/platform/permissions/add.md) - Creates a custom permission set. Restricted to admins only.
  - [Edit Permissions](/docs/api/platform/permissions/edit.md) - Edits a custom permission set. Restricted to admins only.
  - [Delete Permissions](/docs/api/platform/permissions/delete.md) - Deletes a custom permission set. Restricted to admins only.
- [SSO](/docs/api/platform/sso.md) - Learn how to enable, disable and manage workspace SSO in Buddy.
  - [Disable](/docs/api/platform/sso/disable.md) - Disable SSO for the workspace
  - [Enable](/docs/api/platform/sso/enable.md) - Enable SSO for the workspace
  - [Get SSO](/docs/api/platform/sso/get.md) - Get SSO configuration
  - [Update](/docs/api/platform/sso/update.md) - Update SSO configuration
- [Workspaces](/docs/api/platform/workspaces.md) - Learn how to manage workspaces in Buddy.
  - [List Workspaces](/docs/api/platform/workspaces/list.md) - Get all workspaces accessible to the user
  - [Get Workspaces](/docs/api/platform/workspaces/get.md) - Get a specific workspace by domain
  - [Get object ID](/docs/api/platform/workspaces/get-id-by-identifier.md) - Get the ID of an object using its human-readable identifier
- [OIDC](/docs/api/platform/oidc.md) - Learn how to use OpenID Connect for authentication in Buddy.
  - [Issue Token](/docs/api/platform/oidc/issue-token.md) - Issue a short-lived API token using OIDC provider authentication

---
Original source: https://buddy.works/docs/api/platform