Rancher 1.6 Docs

ProjectMember

A “project member” in the API is referred to as an environment members in the UI and Rancher documentation. An environment member is a list of all of the members of the environment. An environment member is an identity.

Resource Fields

Writeable Fields

Field Type Create Update Default Notes
description string Optional Yes -  
externalId string Optional - -  
externalIdType enum Optional - rancher_id The options are rancher_id, ldap_user, ldap_group, openldap_user, openldap_group, azuread_user, azuread_group, github_user, github_org, github_team, shibboleth_user, shibboleth_group.
role enum Optional - member The options are member, owner, readonly, restricted.

Read Only Fields

Field Type Notes
data map[json]  
id int The unique identifier for the projectMember
name string  
projectId project  


Please read more about the common resource fields. These fields are read only and applicable to almost every resource. We have segregated them from the list above.

Operations

CreatePOST: /v2-beta/projects/${PROJECT_ID}/projectMembers

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
-H 'Content-Type: application/json' \
-d '{
	"description": "string",
	"externalId": "string",
	"externalIdType": "rancher_id",
	"role": "member"
}' 'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/projectMembers'

Actions

activate POST: /v2-beta/projects/${PROJECT_ID}/projectMembers/${ID}?action=activate


Input:This action has no inputs


curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/projectMembers/${ID}?action=activate'


Output: An updated copy of the projectMember resource

deactivate POST: /v2-beta/projects/${PROJECT_ID}/projectMembers/${ID}?action=deactivate


Input:This action has no inputs


curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/projectMembers/${ID}?action=deactivate'


Output: An updated copy of the projectMember resource

Edit this page