Skip to main content

Retrieve Project Members

This API can be used to retrieve all users and teams that are members of this project. Does not include loft wide admins.

Project Members example​

An example Project Members:

apiVersion: management.loft.sh/v1
kind: ProjectMembers
metadata: {}
teams:
- info:
    displayName: My Team
    name: my-team
users:
- info:
    displayName: My User
    email: my-email
    name: my-user

Project Members reference​

teams required object[] ​

Teams holds all the teams that have access to the cluster

info required object ​

Info about the user or team

name required string ​

Name is the kubernetes name of the object

displayName required string ​

The display name shown in the UI

icon required string ​

Icon is the icon of the user / team

username required string ​

The username that is used to login

email required string ​

The users email address

subject required string ​

The user subject

users required object[] ​

Users holds all the users that have access to the cluster

info required object ​

Info about the user or team

name required string ​

Name is the kubernetes name of the object

displayName required string ​

The display name shown in the UI

icon required string ​

Icon is the icon of the user / team

username required string ​

The username that is used to login

email required string ​

The users email address

subject required string ​

The user subject

Project Members (Get)​

You can retrieve all project users and teams through this API.

Run the following command:

# Exchange my-object in the url below with the name of the Project Members
kubectl get --raw "/kubernetes/management/apis/management.loft.sh/v1/projects/my-object/members"