Class: SSOReady::Management::SAMLConnectionsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ssoready/management/saml_connections/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ SSOReady::Management::SAMLConnectionsClient 



19
20
21
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 19

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ SSOReady::RequestClient (readonly) 



15
16
17
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 15

def request_client
  @request_client
end

Instance Method Details

#create_saml_connection(request:, request_options: nil) ⇒ SSOReady::CreateSAMLConnectionResponse

Creates a SAML connection.

Examples:

api = SSOReady::Client.new(
  base_url: "https://api.example.com",
  environment: SSOReady::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.management.saml_connections.create_saml_connection(request: {  })



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 78

def create_saml_connection(request:, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/v1/saml-connections"
  end
  SSOReady::CreateSAMLConnectionResponse.from_json(json_object: response.body)
end

#get_saml_connection(id:, request_options: nil) ⇒ SSOReady::GetSAMLConnectionResponse

Gets a SAML connection.

Examples:

api = SSOReady::Client.new(
  base_url: "https://api.example.com",
  environment: SSOReady::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.management.saml_connections.get_saml_connection(id: "id")



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 108

def get_saml_connection(id:, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/v1/saml-connections/#{id}"
  end
  SSOReady::GetSAMLConnectionResponse.from_json(json_object: response.body)
end

#list_saml_connections(organization_id: nil, page_token: nil, request_options: nil) ⇒ SSOReady::ListSAMLConnectionsResponse

Lists SAML connections in an organization.

Examples:

api = SSOReady::Client.new(
  base_url: "https://api.example.com",
  environment: SSOReady::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.management.saml_connections.list_saml_connections



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 36

def list_saml_connections(organization_id: nil, page_token: nil, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "organizationId": organization_id,
      "pageToken": page_token
    }.compact
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/v1/saml-connections"
  end
  SSOReady::ListSAMLConnectionsResponse.from_json(json_object: response.body)
end

#update_saml_connection(id:, request:, request_options: nil) ⇒ SSOReady::UpdateSAMLConnectionResponse

Updates a SAML connection.

Examples:

api = SSOReady::Client.new(
  base_url: "https://api.example.com",
  environment: SSOReady::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.management.saml_connections.update_saml_connection(id: "id", request: {  })



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 149

def update_saml_connection(id:, request:, request_options: nil)
  response = @request_client.conn.patch do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/v1/saml-connections/#{id}"
  end
  SSOReady::UpdateSAMLConnectionResponse.from_json(json_object: response.body)
end