Class: SSOReady::SCIMClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ SSOReady::SCIMClient

Parameters:



17
18
19
 
# File 'lib/ssoready/scim/client.rb', line 17

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ SSOReady::RequestClient (readonly)

Returns:



13
14
15
 
# File 'lib/ssoready/scim/client.rb', line 13

def request_client
  @request_client
end

Instance Method Details

#get_scim_group(id:, request_options: nil) ⇒ SSOReady::GetSCIMGroupResponse

Gets a SCIM group in a SCIM directory.

Examples:

api = SSOReady::Client.new(
  base_url: "https://api.example.com",
  environment: SSOReady::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.scim.get_scim_group(id: "scim_group_...")

Parameters:

Returns:



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/ssoready/scim/client.rb', line 81

def get_scim_group(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/scim/groups/#{id}"
  end
  SSOReady::GetSCIMGroupResponse.from_json(json_object: response.body)
end

#get_scim_user(id:, request_options: nil) ⇒ SSOReady::GetSCIMUserResponse

Gets a SCIM user.

Examples:

api = SSOReady::Client.new(
  base_url: "https://api.example.com",
  environment: SSOReady::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.scim.get_scim_user(id: "scim_user_...")

Parameters:

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/ssoready/scim/client.rb', line 163

def get_scim_user(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/scim/users/#{id}"
  end
  SSOReady::GetSCIMUserResponse.from_json(json_object: response.body)
end

#list_scim_groups(scim_directory_id: nil, organization_id: nil, organization_external_id: nil, page_token: nil, request_options: nil) ⇒ SSOReady::ListSCIMGroupsResponse

Gets a list of SCIM groups in a SCIM directory.

Examples:

api = SSOReady::Client.new(
  base_url: "https://api.example.com",
  environment: SSOReady::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.scim.list_scim_groups(organization_external_id: "my_custom_external_id")

Parameters:

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

    The SCIM directory to list from. One of ‘scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.

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

    The ID of the organization to list from. The primary SCIM directory of this organization is used. One of ‘scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.

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

    The ‘externalId` of the organization to list from. The primary SCIM directory of this organization is used. One of `scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/ssoready/scim/client.rb', line 44

def list_scim_groups(scim_directory_id: nil, organization_id: nil, organization_external_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 || {}),
      "scimDirectoryId": scim_directory_id,
      "organizationId": organization_id,
      "organizationExternalId": organization_external_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/scim/groups"
  end
  SSOReady::ListSCIMGroupsResponse.from_json(json_object: response.body)
end

#list_scim_users(scim_directory_id: nil, organization_id: nil, organization_external_id: nil, scim_group_id: nil, page_token: nil, request_options: nil) ⇒ SSOReady::ListSCIMUsersResponse

Gets a list of SCIM users in a SCIM directory.

Examples:

api = SSOReady::Client.new(
  base_url: "https://api.example.com",
  environment: SSOReady::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.scim.list_scim_users(organization_external_id: "my_custom_external_id")

Parameters:

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

    The SCIM directory to list from. One of ‘scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.

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

    The ID of the organization to list from. The primary SCIM directory of this organization is used. One of ‘scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.

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

    The ‘externalId` of the organization to list from. The primary SCIM directory of this organization is used. One of `scimDirectoryId`, `organizationId`, or `organizationExternalId` must be specified.

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

    If specified, only users that are members of this SCIM group are returned.

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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/ssoready/scim/client.rb', line 125

def list_scim_users(scim_directory_id: nil, organization_id: nil, organization_external_id: nil,
                    scim_group_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 || {}),
      "scimDirectoryId": scim_directory_id,
      "organizationId": organization_id,
      "organizationExternalId": organization_external_id,
      "scimGroupId": scim_group_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/scim/users"
  end
  SSOReady::ListSCIMUsersResponse.from_json(json_object: response.body)
end