Skip to content

Latest commit

 

History

History
254 lines (154 loc) · 10 KB

README.md

File metadata and controls

254 lines (154 loc) · 10 KB

User

(user)

Overview

Available Operations

create_scim_users

Create user

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::CreateScimUsersRequest.new(
  connection_id: "<id>",
)
    
res = s.user.create_scim_users(req)

if ! res.scim_user.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request ::UnifiedRubySDK::Operations::CreateScimUsersRequest ✔️ The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::CreateScimUsersResponse)

get_scim_users

Get user

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.user.get_scim_users(connection_id="<id>", id="<id>")

if ! res.scim_user.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the User

Response

T.nilable(::UnifiedRubySDK::Operations::GetScimUsersResponse)

list_scim_users

List users

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)


req = ::UnifiedRubySDK::Operations::ListScimUsersRequest.new(
  connection_id: "<id>",
)
    
res = s.user.list_scim_users(req)

if ! res.scim_users.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request ::UnifiedRubySDK::Operations::ListScimUsersRequest ✔️ The request object to use for the request.

Response

T.nilable(::UnifiedRubySDK::Operations::ListScimUsersResponse)

patch_scim_users

Update user

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.user.patch_scim_users(connection_id="<id>", id="<id>", scim_user=::UnifiedRubySDK::Shared::ScimUser.new())

if ! res.scim_user.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the User
scim_user T.nilable(::UnifiedRubySDK::Shared::ScimUser) ➖ N/A

Response

T.nilable(::UnifiedRubySDK::Operations::PatchScimUsersResponse)

remove_scim_users

Delete user

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.user.remove_scim_users(connection_id="<id>", id="<id>")

if res.status_code == 200
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the User

Response

T.nilable(::UnifiedRubySDK::Operations::RemoveScimUsersResponse)

update_scim_users

Update user

Example Usage

require 'unified_ruby_sdk'


s = ::UnifiedRubySDK::UnifiedTo.new
s.config_security(
  ::UnifiedRubySDK::Shared::Security.new(
    jwt: "<YOUR_API_KEY_HERE>",
  )
)

    
res = s.user.update_scim_users(connection_id="<id>", id="<id>", scim_user=::UnifiedRubySDK::Shared::ScimUser.new())

if ! res.scim_user.nil?
  # handle response
end

Parameters

Parameter Type Required Description
connection_id ::String ✔️ ID of the connection
id ::String ✔️ ID of the User
scim_user T.nilable(::UnifiedRubySDK::Shared::ScimUser) ➖ N/A

Response

T.nilable(::UnifiedRubySDK::Operations::UpdateScimUsersResponse)