Chapter 8. Teams
This chapter provides information on API resources to create and manage OpenShift Enterprise teams. A team comprises a group of developers for the purpose of access control. Team members are added to a domain similar to how users are added.
The following table describes each parameter associated with an OpenShift Enterprise team.
| Name | Description |
|---|---|
name | Name of the team |
id | Unique identifier of the team |
8.1. Create Team
Description
Create a new team. Note that the maximum number of teams that can be created is determined by the max_teams capability. See Chapter 4, User Information for more information on user capabilities.
When creating a team, the following guidelines apply:
- Team names must be a minimum of 2 characters in length, with a maximum length of 250 characters
- If there are multiple teams under one owner, each team must have a unique name
- Team names cannot be modified
Method and URL Structure
Method URL Structure POST /broker/rest/teams
Request Parameters
Name Description Required Default name [a] Name of the team Yes [a]
Must be minimum of 2 characters, and maximum of 250 characters in length
See Section A.4, “Teams” for more information on request parameters for this resource.
Request
{
"name": "myteam",
}
cURL Command Example
$ curl -X POST https://openshift.redhat.com/broker/rest/teams --user user@example.com:password --data-urlencode name=myteam
JSON Response
The API returns the team resource with related resource links which have been left out for brevity. See Chapter 8, Teams for more information on all team parameters.
{
"api_version": 1.6,
"data": {
"id": "5333d8b2a9429d1c3e0000ae",
"members": [
{
"explicit_role": null,
"from": [
{
"type": "owner",
"role": "view"
}
],
"id": "5333d64fa9429defe8000001",
"links": {
"GET": {
"href": "https://openshift.redhat.com/broker/rest/team/5333d8b2a9429d1c3e0000ae/member/5333d64fa9429defe8000001",
"method": "GET",
"optional_params": [
],
"rel": "Get member",
"required_params": [
]
},
"UPDATE": {
"href": "https://openshift.redhat.com/broker/rest/team/5333d8b2a9429d1c3e0000ae/member/5333d64fa9429defe8000001",
"method": "PUT",
"optional_params": [
],
"rel": "Update member",
"required_params": [
{
"description": "New role for member",
"invalid_options": [
],
"name": "role",
"type": "string",
"valid_options": [
]
}
]
},
"DELETE": {
"href": "https://openshift.redhat.com/broker/rest/team/5333d8b2a9429d1c3e0000ae/member/5333d64fa9429defe8000001",
"method": "DELETE",
"optional_params": [
],
"rel": "Delete member",
"required_params": [
]
}
},
"login": "user@example.com",
"owner": true,
"role": "view",
"type": "user"
}
],
"name": "myteam"
},
"messages": [
{
"exit_code": 0,
"field": null,
"index": null,
"severity": "info",
"text": "Added myteam"
}
],
"status": "created",
"supported_api_versions": [
1.0,
1.1,
1.2,
1.3,
1.4,
1.5,
1.6
],
"type": "team",
"version": "1.6"
}
