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.



1461
1462
1463
 
# File 'lib/platform-api/client.rb', line 1461

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



1476
1477
1478
 
# File 'lib/platform-api/client.rb', line 1476

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



1508
1509
1510
 
# File 'lib/platform-api/client.rb', line 1508

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



1493
1494
1495
 
# File 'lib/platform-api/client.rb', line 1493

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



1525
1526
1527
 
# File 'lib/platform-api/client.rb', line 1525

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



1468
1469
1470
 
# File 'lib/platform-api/client.rb', line 1468

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



1500
1501
1502
 
# File 'lib/platform-api/client.rb', line 1500

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



1485
1486
1487
 
# File 'lib/platform-api/client.rb', line 1485

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



1517
1518
1519
 
# File 'lib/platform-api/client.rb', line 1517

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