Class: SSOReady::Management::OrganizationsClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:



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

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ SSOReady::RequestClient (readonly)

Returns:



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

def request_client
  @request_client
end

Instance Method Details

#create_organization(request:, request_options: nil) ⇒ SSOReady::CreateOrganizationResponse

Creates an organization.

Examples:

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

Parameters:

  • request (Hash) —

    Request of type SSOReady::Organization, as a Hash

    • :id (String)

    • :environment_id (String)

    • :display_name (String)

    • :external_id (String)

    • :domains (Array<String>)

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

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/ssoready/management/organizations/client.rb', line 70

def create_organization(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/organizations"
  end
  SSOReady::CreateOrganizationResponse.from_json(json_object: response.body)
end

#get_organization(id:, request_options: nil) ⇒ SSOReady::GetOrganizationResponse

Gets an organization.

Examples:

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

Parameters:

Returns:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/ssoready/management/organizations/client.rb', line 100

def get_organization(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/organizations/#{id}"
  end
  SSOReady::GetOrganizationResponse.from_json(json_object: response.body)
end

#list_organizations(page_token: nil, request_options: nil) ⇒ SSOReady::ListOrganizationsResponse

Gets a list of organizations.

Examples:

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

Parameters:

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



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/ssoready/management/organizations/client.rb', line 35

def list_organizations(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 || {}), "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/organizations"
  end
  SSOReady::ListOrganizationsResponse.from_json(json_object: response.body)
end

#update_organization(id:, request:, request_options: nil) ⇒ SSOReady::UpdateOrganizationResponse

Updates an organization.

Examples:

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

Parameters:

  • id (String) —

    ID of the organization to update.

  • request (Hash) —

    Request of type SSOReady::Organization, as a Hash

    • :id (String)

    • :environment_id (String)

    • :display_name (String)

    • :external_id (String)

    • :domains (Array<String>)

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

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/ssoready/management/organizations/client.rb', line 138

def update_organization(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/organizations/#{id}"
  end
  SSOReady::UpdateOrganizationResponse.from_json(json_object: response.body)
end