Class: PlatformAPI::IdentityProvider

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

Overview

Identity Providers represent the SAML configuration of an Organization.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ IdentityProvider

Returns a new instance of IdentityProvider.



1714
1715
1716
 
# File 'lib/platform-api/client.rb', line 1714

def initialize(client)
  @client = client
end

Instance Method Details

#create_by_organization(organization_name, body = {}) ⇒ Object

Create an Identity Provider for an organization

Parameters:

  • organization_name: —

    unique name of organization

  • body: —

    the object to pass as the request payload



1729
1730
1731
 
# File 'lib/platform-api/client.rb', line 1729

def create_by_organization(organization_name, body = {})
  @client.identity_provider.create_by_organization(organization_name, body)
end

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

Create an Identity Provider for a team

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team

  • body: —

    the object to pass as the request payload



1761
1762
1763
 
# File 'lib/platform-api/client.rb', line 1761

def create_by_team(team_name_or_team_id, body = {})
  @client.identity_provider.create_by_team(team_name_or_team_id, body)
end

#delete_by_organization(organization_name, identity_provider_id) ⇒ Object

Delete an organization's Identity Provider

Parameters:

  • organization_name: —

    unique name of organization

  • identity_provider_id: —

    unique identifier of this identity provider



1746
1747
1748
 
# File 'lib/platform-api/client.rb', line 1746

def delete_by_organization(organization_name, identity_provider_id)
  @client.identity_provider.delete_by_organization(organization_name, identity_provider_id)
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



1778
1779
1780
 
# File 'lib/platform-api/client.rb', line 1778

def delete_by_team(team_name, identity_provider_id)
  @client.identity_provider.delete_by_team(team_name, identity_provider_id)
end

#list_by_organization(organization_name) ⇒ Object

Get a list of an organization's Identity Providers

Parameters:

  • organization_name: —

    unique name of organization



1721
1722
1723
 
# File 'lib/platform-api/client.rb', line 1721

def list_by_organization(organization_name)
  @client.identity_provider.list_by_organization(organization_name)
end

#list_by_team(team_name_or_team_id) ⇒ Object

Get a list of a team's Identity Providers

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team



1753
1754
1755
 
# File 'lib/platform-api/client.rb', line 1753

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

#update_by_organization(organization_name, identity_provider_id, body = {}) ⇒ Object

Update an organization's Identity Provider

Parameters:

  • organization_name: —

    unique name of organization

  • identity_provider_id: —

    unique identifier of this identity provider

  • body: —

    the object to pass as the request payload



1738
1739
1740
 
# File 'lib/platform-api/client.rb', line 1738

def update_by_organization(organization_name, identity_provider_id, body = {})
  @client.identity_provider.update_by_organization(organization_name, identity_provider_id, body)
end

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

Update a team's Identity Provider

Parameters:

  • team_name_or_team_id: —

    unique name of team or unique identifier of team

  • identity_provider_id: —

    unique identifier of this identity provider

  • body: —

    the object to pass as the request payload



1770
1771
1772
 
# File 'lib/platform-api/client.rb', line 1770

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