Class: PlatformAPI::IdentityProvider

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

Identity Providers represent the SAML configuration of teams or an Enterprise account

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ IdentityProvider

Returns a new instance of IdentityProvider.



1956
1957
1958
 
# File 'lib/platform-api/client.rb', line 1956

def initialize(client)
  @client = client
end

Instance Method Details

#create_by_team(team_name, body = {}) ⇒ Object

Create an Identity Provider for a team

Parameters:

  • team_name: —

    unique name of team

  • body: —

    the object to pass as the request payload



1971
1972
1973
 
# File 'lib/platform-api/client.rb', line 1971

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) ⇒ Object

Delete a team's Identity Provider

Parameters:

  • team_name: —

    unique name of team

  • identity_provider_id: —

    unique identifier of this identity provider



1988
1989
1990
 
# File 'lib/platform-api/client.rb', line 1988

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) ⇒ Object

Get a list of a team's Identity Providers

Parameters:

  • team_name: —

    unique name of team



1963
1964
1965
 
# File 'lib/platform-api/client.rb', line 1963

def list_by_team(team_name)
  @client.identity_provider.list_by_team(team_name)
end

#update_by_team(team_name, identity_provider_id, body = {}) ⇒ Object

Update a team's Identity Provider

Parameters:

  • team_name: —

    unique name of team

  • identity_provider_id: —

    unique identifier of this identity provider

  • body: —

    the object to pass as the request payload



1980
1981
1982
 
# File 'lib/platform-api/client.rb', line 1980

def update_by_team(team_name, identity_provider_id, body = {})
  @client.identity_provider.update_by_team(team_name, identity_provider_id, body)
end