Class: SSOReady::Management::AsyncSAMLConnectionsClient

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::AsyncSAMLConnectionsClient

Parameters:



174
175
176
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 174

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ SSOReady::AsyncRequestClient (readonly)

Returns:



170
171
172
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 170

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: {  })

Parameters:

  • request (Hash) —

    Request of type SSOReady::SAMLConnection, as a Hash

    • :id (String)

    • :organization_id (String)

    • :primary (Boolean)

    • :idp_redirect_url (String)

    • :idp_certificate (String)

    • :idp_entity_id (String)

    • :sp_entity_id (String)

    • :sp_acs_url (String)

  • request_options (SSOReady::RequestOptions) (defaults to: nil)

Returns:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 235

def create_saml_connection(request:, request_options: nil)
  Async do
    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
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")

Parameters:

Returns:



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 267

def get_saml_connection(id:, request_options: nil)
  Async do
    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
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

Parameters:

  • organization_id (String) (defaults to: nil) —

    The organization the SAML connections belong to.

  • page_token (String) (defaults to: nil) —

    Pagination token. Leave empty to get the first page of results.

  • request_options (SSOReady::RequestOptions) (defaults to: nil)

Returns:



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 191

def list_saml_connections(organization_id: nil, page_token: nil, request_options: nil)
  Async do
    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
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: {  })

Parameters:

  • id (String) —

    The ID of the SAML connection to update.

  • request (Hash) —

    Request of type SSOReady::SAMLConnection, as a Hash

    • :id (String)

    • :organization_id (String)

    • :primary (Boolean)

    • :idp_redirect_url (String)

    • :idp_certificate (String)

    • :idp_entity_id (String)

    • :sp_entity_id (String)

    • :sp_acs_url (String)

  • request_options (SSOReady::RequestOptions) (defaults to: nil)

Returns:



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/ssoready/management/saml_connections/client.rb', line 310

def update_saml_connection(id:, request:, request_options: nil)
  Async do
    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
end