Class: PEClient::Resource::RBACV1::SAML

Inherits:
Base
  • Object
show all
Defined in:
lib/pe_client/resources/rbac.v1/saml.rb

Overview

Use the saml endpoints to configure SAML, retrieve SAML configuration details, and get the public certificate and URLs needed for configuration.

See Also:

Constant Summary collapse

BASE_PATH =

The base path for RBAC API v1 SAML endpoints.

"#{RBACV1::BASE_PATH}/saml".freeze

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from PEClient::Resource::Base

Instance Method Details

#configure(attributes) ⇒ Hash

Use this endpoint to configure SAML.

Parameters:

  • attributes (Hash) —

    The SAML configuration attributes.

Returns:

  • (Hash)

See Also:



36
37
38
 
# File 'lib/pe_client/resources/rbac.v1/saml.rb', line 36

def configure(attributes)
  @client.put "#{BASE_PATH}/configure", body: attributes
end

#delete ⇒ Hash

Remove the current SAML configuration along with associated user groups and users.

Returns:

  • (Hash) —

    If successful, returns an empty JSON object.



50
51
52
 
# File 'lib/pe_client/resources/rbac.v1/saml.rb', line 50

def delete
  @client.delete BASE_PATH
end

#get ⇒ Hash

Retrieves the current SAML configuration settings.

Returns:

  • (Hash) 


43
44
45
 
# File 'lib/pe_client/resources/rbac.v1/saml.rb', line 43

def get
  @client.get BASE_PATH
end

#meta ⇒ Hash

Retrieve the public SAML certificate and URLs you need to configure an identity provider.

Returns:

  • (Hash) 


57
58
59
 
# File 'lib/pe_client/resources/rbac.v1/saml.rb', line 57

def meta
  @client.get "#{BASE_PATH}/meta"
end