9.2. Add or Remove Domain Members

Description

Add or remove one or more domain members. If a member has the admin role on a domain, they can:

Add a team they own as a member of a domain
Change the role of any team that is already a member of a domain
Remove any team that is already a member of a domain

Note that the number of teams allowed in a domain is determined by the MAX_TEAMS_PER_RESOURCE parameter.

Method and URL Structure

Expand

Method	URL Structure
`PATCH`	`/broker/rest/domains/:name/members`

Request Parameters

Expand

Name	Description	Required	Default
`role`	Type of role a member has on the domain	Yes
`id`	Unique user or team identifier	No
`login`	User's login attribute; only used when the member type is 'user'	No
`type`	Indicates whether a member is a user, or a team	No	`user`
`members`	An array of members to add with corresponding `id` or user `login`, `type`, and `role`

See Section A.5, “Members” for more information about the valid options applicable to these request parameters.

Request

{
  "role": "view",
  "login": "member@example.com"
}

{
  "role": "view",
  "login": "member@example.com"
}

Copy to Clipboard

Toggle word wrap

cURL Command Example

curl -X PATCH https://openshift.redhat.com/broker/rest/domains/mydomain/members --user user@example.com:password --data-urlencode role=view --data-urlencode login=member@memberemail.com

$ curl -X PATCH https://openshift.redhat.com/broker/rest/domains/mydomain/members --user user@example.com:password --data-urlencode role=view --data-urlencode login=member@memberemail.com

Copy to Clipboard

Toggle word wrap

JSON Response

The sample JSON response below shows that a new domain member has been added.

{
    "api_version": 1.6,
    "data": {
        "explicit_role": "view",
        "id": "526097602587c8242100006b",
        "login": "member@memberemail.com",
        "owner": false,
        "role": "view",
        "type": "user"
    },
    "messages": [
        {
            "exit_code": 0,
            "field": null,
            "index": null,
            "severity": "info",
            "text": "Added 1 member."
        }
    ],
    "status": "ok",
    "supported_api_versions": [
	    1.0,
	    1.1,
	    1.2,
	    1.3,
	    1.4,
	    1.5,
	    1.6
	  ],
	  "type": "member",
	  "version": "1.6"
}

{
    "api_version": 1.6,
    "data": {
        "explicit_role": "view",
        "id": "526097602587c8242100006b",
        "login": "member@memberemail.com",
        "owner": false,
        "role": "view",
        "type": "user"
    },
    "messages": [
        {
            "exit_code": 0,
            "field": null,
            "index": null,
            "severity": "info",
            "text": "Added 1 member."
        }
    ],
    "status": "ok",
    "supported_api_versions": [
	    1.0,
	    1.1,
	    1.2,
	    1.3,
	    1.4,
	    1.5,
	    1.6
	  ],
	  "type": "member",
	  "version": "1.6"
}

Copy to Clipboard

Toggle word wrap

返回顶部

此内容没有您所选择的语言版本。

9.2. Add or Remove Domain Members

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links