class PlatformAPI::Team

Teams allow you to manage access to a shared group of applications and other resources.

Public Class Methods

new(client) click to toggle source
# File lib/platform-api/client.rb, line 3440
def initialize(client)
  @client = client
end

Public Instance Methods

create(body = {}) click to toggle source

Create a new team.

@param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 3467
def create(body = {})
  @client.team.create(body)
end
create_in_enterprise_account(enterprise_account_id, body = {}) click to toggle source

Create a team in an enterprise account.

@param enterprise_account_id: unique identifier of the enterprise account @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 3489
def create_in_enterprise_account(enterprise_account_id, body = {})
  @client.team.create_in_enterprise_account(enterprise_account_id, body)
end
delete(team_name_or_team_id) click to toggle source

Delete an existing team.

@param team_name_or_team_id: unique name of team or unique identifier of team

# File lib/platform-api/client.rb, line 3474
def delete(team_name_or_team_id)
  @client.team.delete(team_name_or_team_id)
end
info(team_name_or_team_id) click to toggle source

Info for a team.

@param team_name_or_team_id: unique name of team or unique identifier of team

# File lib/platform-api/client.rb, line 3452
def info(team_name_or_team_id)
  @client.team.info(team_name_or_team_id)
end
list() click to toggle source

List teams in which you are a member.

# File lib/platform-api/client.rb, line 3445
def list()
  @client.team.list()
end
list_by_enterprise_account(enterprise_account_id) click to toggle source

List teams for an enterprise account.

@param enterprise_account_id: unique identifier of the enterprise account

# File lib/platform-api/client.rb, line 3481
def list_by_enterprise_account(enterprise_account_id)
  @client.team.list_by_enterprise_account(enterprise_account_id)
end
update(team_name_or_team_id, body = {}) click to toggle source

Update team properties.

@param team_name_or_team_id: unique name of team or unique identifier of team @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 3460
def update(team_name_or_team_id, body = {})
  @client.team.update(team_name_or_team_id, body)
end