class PlatformAPI::IdentityProvider

Identity Providers represent the SAML configuration of an Team.

Public Class Methods

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

Public Instance Methods

create_by_team(team_name, body = {}) click to toggle source

Create an Identity Provider for a team

@param team_name: unique name of team @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 1969
def create_by_team(team_name, body = {})
  @client.identity_provider.create_by_team(team_name, body)
end
delete_by_team(team_name, identity_provider_id) click to toggle source

Delete a team's Identity Provider

@param team_name: unique name of team @param identity_provider_id: unique identifier of this identity provider

# File lib/platform-api/client.rb, line 1986
def delete_by_team(team_name, identity_provider_id)
  @client.identity_provider.delete_by_team(team_name, identity_provider_id)
end
list_by_team(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 1961
def list_by_team(team_name)
  @client.identity_provider.list_by_team(team_name)
end
update_by_team(team_name, identity_provider_id, body = {}) click to toggle source

Update a team's Identity Provider

@param team_name: unique name of team @param identity_provider_id: unique identifier of this identity provider @param body: the object to pass as the request payload

# File lib/platform-api/client.rb, line 1978
def update_by_team(team_name, identity_provider_id, body = {})
  @client.identity_provider.update_by_team(team_name, identity_provider_id, body)
end