Class: PlatformAPI::IdentityProvider

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

Overview

Identity Providers represent the SAML configuration of an Team.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ IdentityProvider

Returns a new instance of IdentityProvider.



1954
1955
1956
# File 'lib/platform-api/client.rb', line 1954

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



1969
1970
1971
# 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) ⇒ Object

Delete a team's Identity Provider

Parameters:

  • team_name:

    unique name of team

  • identity_provider_id:

    unique identifier of this identity provider



1986
1987
1988
# 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) ⇒ Object

Get a list of a team's Identity Providers

Parameters:

  • team_name:

    unique name of team



1961
1962
1963
# 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 = {}) ⇒ 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



1978
1979
1980
# 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