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.



1340
1341
1342
 
# File 'lib/platform-api/client.rb', line 1340

def initialize(client)
  @client = client
end

Instance Method Details

#create(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



1355
1356
1357
 
# File 'lib/platform-api/client.rb', line 1355

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

#delete(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



1372
1373
1374
 
# File 'lib/platform-api/client.rb', line 1372

def delete(organization_name, identity_provider_id)
  @client.identity_provider.delete(organization_name, identity_provider_id)
end

#list(organization_name) ⇒ Object

Get a list of an organization's Identity Providers

Parameters:

  • organization_name: —

    unique name of organization



1347
1348
1349
 
# File 'lib/platform-api/client.rb', line 1347

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

#update(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



1364
1365
1366
 
# File 'lib/platform-api/client.rb', line 1364

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