class PlatformAPI::TeamInvitation
A team invitation represents an invite to a team.
Public Class Methods
new(client)
click to toggle source
# File lib/platform-api/client.rb, line 3256 def initialize(client) @client = client end
Public Instance Methods
accept(team_invitation_token)
click to toggle source
Accept Team
Invitation
@param team_invitation_token: special token for invitation
# File lib/platform-api/client.rb, line 3293 def accept(team_invitation_token) @client.team_invitation.accept(team_invitation_token) end
create(team_name_or_team_id, body = {})
click to toggle source
Create Team
Invitation
@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 3271 def create(team_name_or_team_id, body = {}) @client.team_invitation.create(team_name_or_team_id, body) end
get(team_invitation_token)
click to toggle source
Get an invitation by its token
@param team_invitation_token: special token for invitation
# File lib/platform-api/client.rb, line 3286 def get(team_invitation_token) @client.team_invitation.get(team_invitation_token) end
list(team_name)
click to toggle source
Get a list of a team's Identity Providers
@param team_name: unique name of team
# File lib/platform-api/client.rb, line 3263 def list(team_name) @client.team_invitation.list(team_name) end
revoke(team_name_or_team_id, team_invitation_id)
click to toggle source
Revoke a team invitation.
@param team_name_or_team_id: unique name of team or unique identifier of team @param team_invitation_id: unique identifier of an invitation
# File lib/platform-api/client.rb, line 3279 def revoke(team_name_or_team_id, team_invitation_id) @client.team_invitation.revoke(team_name_or_team_id, team_invitation_id) end