Skip to content

Latest commit

 

History

History
1582 lines (1117 loc) · 53.8 KB

UserManagement.md

File metadata and controls

1582 lines (1117 loc) · 53.8 KB

Falcon::UserManagement

All URIs are relative to https://api.us-2.crowdstrike.com

Method HTTP request Description
combined_user_roles_v1 GET /user-management/combined/user-roles/v1 Get User Grant(s). This endpoint lists both direct as well as flight control grants between a User and a Customer.
create_user POST /users/entities/users/v1 Deprecated : Please use POST /user-management/entities/users/v1. Create a new user. After creating a user, assign one or more roles with POST /user-roles/entities/user-roles/v1
create_user_v1 POST /user-management/entities/users/v1 Create a new user. After creating a user, assign one or more roles with POST '/user-management/entities/user-role-actions/v1'
delete_user DELETE /users/entities/users/v1 Deprecated : Please use DELETE /user-management/entities/users/v1. Delete a user permanently
delete_user_v1 DELETE /user-management/entities/users/v1 Delete a user permanently.
entities_roles_v1 GET /user-management/entities/roles/v1 Get info about a role
get_available_role_ids GET /user-roles/queries/user-role-ids-by-cid/v1 Deprecated : Please use GET /user-management/queries/roles/v1. Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to `/customer/entities/roles/v1`.
get_roles GET /user-roles/entities/user-roles/v1 Deprecated : Please use GET /user-management/entities/roles/v1. Get info about a role
get_user_role_ids GET /user-roles/queries/user-role-ids-by-user-uuid/v1 Deprecated : Please use GET /user-management/combined/user-roles/v1. Show role IDs of roles assigned to a user. For more information on each role, provide the role ID to `/customer/entities/roles/v1`.
grant_user_role_ids POST /user-roles/entities/user-roles/v1 Deprecated : Please use POST /user-management/entities/user-role-actions/v1. Assign one or more roles to a user
queries_roles_v1 GET /user-management/queries/roles/v1 Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to `/user-management/entities/roles/v1`.
query_user_v1 GET /user-management/queries/users/v1 List user IDs for all users in your customer account. For more information on each user, provide the user ID to `/user-management/entities/users/GET/v1`.
retrieve_emails_by_cid GET /users/queries/emails-by-cid/v1 Deprecated : Please use POST /user-management/entities/users/GET/v1. List the usernames (usually an email address) for all users in your customer account
retrieve_user GET /users/entities/users/v1 Deprecated : Please use POST /user-management/entities/users/GET/v1. Get info about a user
retrieve_user_uuid GET /users/queries/user-uuids-by-email/v1 Deprecated : Please use GET /user-management/queries/users/v1. Get a user's ID by providing a username (usually an email address)
retrieve_user_uuids_by_cid GET /users/queries/user-uuids-by-cid/v1 Deprecated : Please use GET /user-management/queries/users/v1. List user IDs for all users in your customer account. For more information on each user, provide the user ID to `/users/entities/user/v1`.
retrieve_users_getv1 POST /user-management/entities/users/GET/v1 Get info about users including their name, UID and CID by providing user UUIDs
revoke_user_role_ids DELETE /user-roles/entities/user-roles/v1 Deprecated : Please use POST /user-management/entities/user-role-actions/v1. Revoke one or more roles from a user
update_user PATCH /users/entities/users/v1 Deprecated : Please use PATCH /user-management/entities/users/v1. Modify an existing user's first or last name
update_user_v1 PATCH /user-management/entities/users/v1 Modify an existing user's first or last name.
user_action_v1 POST /user-management/entities/user-actions/v1 Apply actions to one or more User. Available action names: reset_2fa, reset_password. User UUIDs can be provided in `ids` param as part of request payload.
user_roles_action_v1 POST /user-management/entities/user-role-actions/v1 Grant or Revoke one or more role(s) to a user against a CID. User UUID, CID and Role ID(s) can be provided in request payload. Available Action(s) : grant, revoke

combined_user_roles_v1

combined_user_roles_v1(user_uuid, opts)

Get User Grant(s). This endpoint lists both direct as well as flight control grants between a User and a Customer.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
user_uuid = 'user_uuid_example' # String | User UUID to get available roles for.
opts = {
  cid: 'cid_example', # String | Customer ID to get grants for. Empty CID would result in Role IDs for user against current CID in view.
  direct_only: true, # Boolean | Specifies if to request direct Only role grants or all role grants between user and CID (specified in query params)
  filter: 'filter_example', # String | Filter using a query in Falcon Query Language (FQL). Supported filters: role_id, role_name
  offset: 56, # Integer | The offset to start retrieving records from
  limit: 56, # Integer | The maximum records to return. [1-500]
  sort: 'cid|asc' # String | The property to sort by
}

begin
  # Get User Grant(s). This endpoint lists both direct as well as flight control grants between a User and a Customer.
  result = api_instance.combined_user_roles_v1(user_uuid, opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->combined_user_roles_v1: #{e}"
end

Using the combined_user_roles_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> combined_user_roles_v1_with_http_info(user_uuid, opts)

begin
  # Get User Grant(s). This endpoint lists both direct as well as flight control grants between a User and a Customer.
  data, status_code, headers = api_instance.combined_user_roles_v1_with_http_info(user_uuid, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlightcontrolapiUserGrantResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->combined_user_roles_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
user_uuid String User UUID to get available roles for.
cid String Customer ID to get grants for. Empty CID would result in Role IDs for user against current CID in view. [optional]
direct_only Boolean Specifies if to request direct Only role grants or all role grants between user and CID (specified in query params) [optional][default to false]
filter String Filter using a query in Falcon Query Language (FQL). Supported filters: role_id, role_name [optional]
offset Integer The offset to start retrieving records from [optional][default to 0]
limit Integer The maximum records to return. [1-500] [optional][default to 100]
sort String The property to sort by [optional][default to 'role_name

Return type

FlightcontrolapiUserGrantResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

create_user

create_user(body)

Deprecated : Please use POST /user-management/entities/users/v1. Create a new user. After creating a user, assign one or more roles with POST /user-roles/entities/user-roles/v1

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
body = Falcon::DomainUserCreateRequest.new # DomainUserCreateRequest | Attributes for this user. `uid` (required) is the user's email address, which is their username in Falcon.  Optional attributes:  <ul><li>`firstName`</li><li>`lastName`</li><li>`password`</li></ul>  As a best practice, we recommend omitting `password`. If single sign-on is enabled for your customer account, the `password` attribute is ignored. If single sign-on is not enabled, we send a user activation request to their email address when you create the user with no `password`. The user should use the activation email to set their own password.

begin
  # Deprecated : Please use POST /user-management/entities/users/v1. Create a new user. After creating a user, assign one or more roles with POST /user-roles/entities/user-roles/v1
  result = api_instance.create_user(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->create_user: #{e}"
end

Using the create_user_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_user_with_http_info(body)

begin
  # Deprecated : Please use POST /user-management/entities/users/v1. Create a new user. After creating a user, assign one or more roles with POST /user-roles/entities/user-roles/v1
  data, status_code, headers = api_instance.create_user_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiUserMetadataResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->create_user_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body DomainUserCreateRequest Attributes for this user. `uid` (required) is the user's email address, which is their username in Falcon. Optional attributes: <ul><li>`firstName`</li><li>`lastName`</li><li>`password`</li></ul> As a best practice, we recommend omitting `password`. If single sign-on is enabled for your customer account, the `password` attribute is ignored. If single sign-on is not enabled, we send a user activation request to their email address when you create the user with no `password`. The user should use the activation email to set their own password.

Return type

ApiUserMetadataResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

create_user_v1

create_user_v1(body, opts)

Create a new user. After creating a user, assign one or more roles with POST '/user-management/entities/user-role-actions/v1'

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
body = Falcon::DomainCreateUserRequest.new # DomainCreateUserRequest | Attributes for this user. `uid` (required) is the user's email address, which is their username in Falcon.  Optional attributes:  <ul><li>`firstName`</li><li>`lastName`</li><li>`password`</li></ul>  As a best practice, we recommend omitting `password`. If single sign-on is enabled for your customer account, the `password` attribute is ignored. If single sign-on is not enabled, we send a user activation request to their email address when you create the user with no `password`. The user should use the activation email to set their own password.
opts = {
  validate_only: true # Boolean | Validate of user is allowed, but do not create user.
}

begin
  # Create a new user. After creating a user, assign one or more roles with POST '/user-management/entities/user-role-actions/v1'
  result = api_instance.create_user_v1(body, opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->create_user_v1: #{e}"
end

Using the create_user_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_user_v1_with_http_info(body, opts)

begin
  # Create a new user. After creating a user, assign one or more roles with POST '/user-management/entities/user-role-actions/v1'
  data, status_code, headers = api_instance.create_user_v1_with_http_info(body, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlightcontrolapiUserResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->create_user_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body DomainCreateUserRequest Attributes for this user. `uid` (required) is the user's email address, which is their username in Falcon. Optional attributes: <ul><li>`firstName`</li><li>`lastName`</li><li>`password`</li></ul> As a best practice, we recommend omitting `password`. If single sign-on is enabled for your customer account, the `password` attribute is ignored. If single sign-on is not enabled, we send a user activation request to their email address when you create the user with no `password`. The user should use the activation email to set their own password.
validate_only Boolean Validate of user is allowed, but do not create user. [optional][default to false]

Return type

FlightcontrolapiUserResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

delete_user

delete_user(user_uuid)

Deprecated : Please use DELETE /user-management/entities/users/v1. Delete a user permanently

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
user_uuid = 'user_uuid_example' # String | ID of a user. Find a user's ID from `/users/entities/user/v1`.

begin
  # Deprecated : Please use DELETE /user-management/entities/users/v1. Delete a user permanently
  result = api_instance.delete_user(user_uuid)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->delete_user: #{e}"
end

Using the delete_user_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_user_with_http_info(user_uuid)

begin
  # Deprecated : Please use DELETE /user-management/entities/users/v1. Delete a user permanently
  data, status_code, headers = api_instance.delete_user_with_http_info(user_uuid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaReplyMetaOnly>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->delete_user_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
user_uuid String ID of a user. Find a user's ID from `/users/entities/user/v1`.

Return type

MsaReplyMetaOnly

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

delete_user_v1

delete_user_v1(user_uuid)

Delete a user permanently.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
user_uuid = 'user_uuid_example' # String | User UUID.

begin
  # Delete a user permanently.
  result = api_instance.delete_user_v1(user_uuid)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->delete_user_v1: #{e}"
end

Using the delete_user_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_user_v1_with_http_info(user_uuid)

begin
  # Delete a user permanently.
  data, status_code, headers = api_instance.delete_user_v1_with_http_info(user_uuid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaspecResponseFields>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->delete_user_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
user_uuid String User UUID.

Return type

MsaspecResponseFields

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

entities_roles_v1

entities_roles_v1(ids, opts)

Get info about a role

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
ids = ['inner_example'] # Array<String> | ID of a role. Find a role ID from `/user-management/queries/roles/v1`.
opts = {
  cid: 'cid_example' # String | Customer ID to get available roles for. Empty CID would result in Role IDs for current CID in view.
}

begin
  # Get info about a role
  result = api_instance.entities_roles_v1(ids, opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->entities_roles_v1: #{e}"
end

Using the entities_roles_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> entities_roles_v1_with_http_info(ids, opts)

begin
  # Get info about a role
  data, status_code, headers = api_instance.entities_roles_v1_with_http_info(ids, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlightcontrolapiGetRolesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->entities_roles_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ids Array<String> ID of a role. Find a role ID from `/user-management/queries/roles/v1`.
cid String Customer ID to get available roles for. Empty CID would result in Role IDs for current CID in view. [optional]

Return type

FlightcontrolapiGetRolesResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_available_role_ids

get_available_role_ids

Deprecated : Please use GET /user-management/queries/roles/v1. Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to /customer/entities/roles/v1.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new

begin
  # Deprecated : Please use GET /user-management/queries/roles/v1. Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to `/customer/entities/roles/v1`.
  result = api_instance.get_available_role_ids
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->get_available_role_ids: #{e}"
end

Using the get_available_role_ids_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_available_role_ids_with_http_info

begin
  # Deprecated : Please use GET /user-management/queries/roles/v1. Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to `/customer/entities/roles/v1`.
  data, status_code, headers = api_instance.get_available_role_ids_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->get_available_role_ids_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

MsaQueryResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_roles

get_roles(ids)

Deprecated : Please use GET /user-management/entities/roles/v1. Get info about a role

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
ids = ['inner_example'] # Array<String> | ID of a role. Find a role ID from `/customer/queries/roles/v1` or `/users/queries/roles/v1`.

begin
  # Deprecated : Please use GET /user-management/entities/roles/v1. Get info about a role
  result = api_instance.get_roles(ids)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->get_roles: #{e}"
end

Using the get_roles_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_roles_with_http_info(ids)

begin
  # Deprecated : Please use GET /user-management/entities/roles/v1. Get info about a role
  data, status_code, headers = api_instance.get_roles_with_http_info(ids)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiUserRoleResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->get_roles_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ids Array<String> ID of a role. Find a role ID from `/customer/queries/roles/v1` or `/users/queries/roles/v1`.

Return type

ApiUserRoleResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_user_role_ids

get_user_role_ids(user_uuid)

Deprecated : Please use GET /user-management/combined/user-roles/v1. Show role IDs of roles assigned to a user. For more information on each role, provide the role ID to /customer/entities/roles/v1.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
user_uuid = 'user_uuid_example' # String | ID of a user. Find a user's ID from `/users/entities/user/v1`.

begin
  # Deprecated : Please use GET /user-management/combined/user-roles/v1. Show role IDs of roles assigned to a user. For more information on each role, provide the role ID to `/customer/entities/roles/v1`.
  result = api_instance.get_user_role_ids(user_uuid)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->get_user_role_ids: #{e}"
end

Using the get_user_role_ids_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_user_role_ids_with_http_info(user_uuid)

begin
  # Deprecated : Please use GET /user-management/combined/user-roles/v1. Show role IDs of roles assigned to a user. For more information on each role, provide the role ID to `/customer/entities/roles/v1`.
  data, status_code, headers = api_instance.get_user_role_ids_with_http_info(user_uuid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->get_user_role_ids_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
user_uuid String ID of a user. Find a user's ID from `/users/entities/user/v1`.

Return type

MsaQueryResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

grant_user_role_ids

grant_user_role_ids(user_uuid, body)

Deprecated : Please use POST /user-management/entities/user-role-actions/v1. Assign one or more roles to a user

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
user_uuid = 'user_uuid_example' # String | ID of a user. Find a user's ID from `/users/entities/user/v1`.
body = Falcon::DomainRoleIDs.new({role_ids: ['role_ids_example']}) # DomainRoleIDs | Role ID(s) of the role you want to assign

begin
  # Deprecated : Please use POST /user-management/entities/user-role-actions/v1. Assign one or more roles to a user
  result = api_instance.grant_user_role_ids(user_uuid, body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->grant_user_role_ids: #{e}"
end

Using the grant_user_role_ids_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> grant_user_role_ids_with_http_info(user_uuid, body)

begin
  # Deprecated : Please use POST /user-management/entities/user-role-actions/v1. Assign one or more roles to a user
  data, status_code, headers = api_instance.grant_user_role_ids_with_http_info(user_uuid, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiUserRoleIDsResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->grant_user_role_ids_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
user_uuid String ID of a user. Find a user's ID from `/users/entities/user/v1`.
body DomainRoleIDs Role ID(s) of the role you want to assign

Return type

ApiUserRoleIDsResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

queries_roles_v1

queries_roles_v1(opts)

Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to /user-management/entities/roles/v1.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
opts = {
  cid: 'cid_example', # String | Customer ID to get available roles for. Empty CID would result in Role IDs for current CID in view.
  user_uuid: 'user_uuid_example', # String | User UUID to get available roles for. Empty User UUID would returns all roles IDs available for customer.
  action: 'action_example' # String | Actionable purpose of the query
}

begin
  # Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to `/user-management/entities/roles/v1`.
  result = api_instance.queries_roles_v1(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->queries_roles_v1: #{e}"
end

Using the queries_roles_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> queries_roles_v1_with_http_info(opts)

begin
  # Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to `/user-management/entities/roles/v1`.
  data, status_code, headers = api_instance.queries_roles_v1_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaspecQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->queries_roles_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
cid String Customer ID to get available roles for. Empty CID would result in Role IDs for current CID in view. [optional]
user_uuid String User UUID to get available roles for. Empty User UUID would returns all roles IDs available for customer. [optional]
action String Actionable purpose of the query [optional][default to 'grant']

Return type

MsaspecQueryResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

query_user_v1

query_user_v1(opts)

List user IDs for all users in your customer account. For more information on each user, provide the user ID to /user-management/entities/users/GET/v1.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
opts = {
  filter: 'filter_example', # String | Filter using a query in Falcon Query Language (FQL). Supported filters: assigned_cids, cid, first_name, last_name, name, uid
  offset: 56, # Integer | The offset to start retrieving records from
  limit: 56, # Integer | The maximum records to return. [1-500]
  sort: 'cid_name|asc' # String | The property to sort by
}

begin
  # List user IDs for all users in your customer account. For more information on each user, provide the user ID to `/user-management/entities/users/GET/v1`.
  result = api_instance.query_user_v1(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->query_user_v1: #{e}"
end

Using the query_user_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> query_user_v1_with_http_info(opts)

begin
  # List user IDs for all users in your customer account. For more information on each user, provide the user ID to `/user-management/entities/users/GET/v1`.
  data, status_code, headers = api_instance.query_user_v1_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaspecQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->query_user_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
filter String Filter using a query in Falcon Query Language (FQL). Supported filters: assigned_cids, cid, first_name, last_name, name, uid [optional]
offset Integer The offset to start retrieving records from [optional][default to 0]
limit Integer The maximum records to return. [1-500] [optional][default to 100]
sort String The property to sort by [optional][default to 'uid

Return type

MsaspecQueryResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

retrieve_emails_by_cid

retrieve_emails_by_cid

Deprecated : Please use POST /user-management/entities/users/GET/v1. List the usernames (usually an email address) for all users in your customer account

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new

begin
  # Deprecated : Please use POST /user-management/entities/users/GET/v1. List the usernames (usually an email address) for all users in your customer account
  result = api_instance.retrieve_emails_by_cid
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->retrieve_emails_by_cid: #{e}"
end

Using the retrieve_emails_by_cid_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> retrieve_emails_by_cid_with_http_info

begin
  # Deprecated : Please use POST /user-management/entities/users/GET/v1. List the usernames (usually an email address) for all users in your customer account
  data, status_code, headers = api_instance.retrieve_emails_by_cid_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->retrieve_emails_by_cid_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

MsaQueryResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

retrieve_user

retrieve_user(ids)

Deprecated : Please use POST /user-management/entities/users/GET/v1. Get info about a user

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
ids = ['inner_example'] # Array<String> | ID of a user. Find a user's ID from `/users/entities/user/v1`.

begin
  # Deprecated : Please use POST /user-management/entities/users/GET/v1. Get info about a user
  result = api_instance.retrieve_user(ids)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->retrieve_user: #{e}"
end

Using the retrieve_user_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> retrieve_user_with_http_info(ids)

begin
  # Deprecated : Please use POST /user-management/entities/users/GET/v1. Get info about a user
  data, status_code, headers = api_instance.retrieve_user_with_http_info(ids)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiUserMetadataResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->retrieve_user_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ids Array<String> ID of a user. Find a user's ID from `/users/entities/user/v1`.

Return type

ApiUserMetadataResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

retrieve_user_uuid

retrieve_user_uuid(uid)

Deprecated : Please use GET /user-management/queries/users/v1. Get a user's ID by providing a username (usually an email address)

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
uid = ['inner_example'] # Array<String> | A username. This is usually the user's email address, but may vary based on your configuration.

begin
  # Deprecated : Please use GET /user-management/queries/users/v1. Get a user's ID by providing a username (usually an email address)
  result = api_instance.retrieve_user_uuid(uid)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->retrieve_user_uuid: #{e}"
end

Using the retrieve_user_uuid_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> retrieve_user_uuid_with_http_info(uid)

begin
  # Deprecated : Please use GET /user-management/queries/users/v1. Get a user's ID by providing a username (usually an email address)
  data, status_code, headers = api_instance.retrieve_user_uuid_with_http_info(uid)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->retrieve_user_uuid_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
uid Array<String> A username. This is usually the user's email address, but may vary based on your configuration.

Return type

MsaQueryResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

retrieve_user_uuids_by_cid

retrieve_user_uuids_by_cid

Deprecated : Please use GET /user-management/queries/users/v1. List user IDs for all users in your customer account. For more information on each user, provide the user ID to /users/entities/user/v1.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new

begin
  # Deprecated : Please use GET /user-management/queries/users/v1. List user IDs for all users in your customer account. For more information on each user, provide the user ID to `/users/entities/user/v1`.
  result = api_instance.retrieve_user_uuids_by_cid
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->retrieve_user_uuids_by_cid: #{e}"
end

Using the retrieve_user_uuids_by_cid_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> retrieve_user_uuids_by_cid_with_http_info

begin
  # Deprecated : Please use GET /user-management/queries/users/v1. List user IDs for all users in your customer account. For more information on each user, provide the user ID to `/users/entities/user/v1`.
  data, status_code, headers = api_instance.retrieve_user_uuids_by_cid_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->retrieve_user_uuids_by_cid_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

MsaQueryResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

retrieve_users_getv1

retrieve_users_getv1(body)

Get info about users including their name, UID and CID by providing user UUIDs

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
body = Falcon::MsaspecIdsRequest.new({ids: ['ids_example']}) # MsaspecIdsRequest | Maximum of 5000 User UUIDs can be specified per request.

begin
  # Get info about users including their name, UID and CID by providing user UUIDs
  result = api_instance.retrieve_users_getv1(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->retrieve_users_getv1: #{e}"
end

Using the retrieve_users_getv1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> retrieve_users_getv1_with_http_info(body)

begin
  # Get info about users including their name, UID and CID by providing user UUIDs
  data, status_code, headers = api_instance.retrieve_users_getv1_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlightcontrolapiUserResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->retrieve_users_getv1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body MsaspecIdsRequest Maximum of 5000 User UUIDs can be specified per request.

Return type

FlightcontrolapiUserResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

revoke_user_role_ids

revoke_user_role_ids(user_uuid, ids)

Deprecated : Please use POST /user-management/entities/user-role-actions/v1. Revoke one or more roles from a user

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
user_uuid = 'user_uuid_example' # String | ID of a user. Find a user's ID from `/users/entities/user/v1`.
ids = ['inner_example'] # Array<String> | One or more role IDs to revoke. Find a role's ID from `/users/queries/roles/v1`.

begin
  # Deprecated : Please use POST /user-management/entities/user-role-actions/v1. Revoke one or more roles from a user
  result = api_instance.revoke_user_role_ids(user_uuid, ids)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->revoke_user_role_ids: #{e}"
end

Using the revoke_user_role_ids_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> revoke_user_role_ids_with_http_info(user_uuid, ids)

begin
  # Deprecated : Please use POST /user-management/entities/user-role-actions/v1. Revoke one or more roles from a user
  data, status_code, headers = api_instance.revoke_user_role_ids_with_http_info(user_uuid, ids)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiUserRoleIDsResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->revoke_user_role_ids_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
user_uuid String ID of a user. Find a user's ID from `/users/entities/user/v1`.
ids Array<String> One or more role IDs to revoke. Find a role's ID from `/users/queries/roles/v1`.

Return type

ApiUserRoleIDsResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

update_user

update_user(user_uuid, body)

Deprecated : Please use PATCH /user-management/entities/users/v1. Modify an existing user's first or last name

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
user_uuid = 'user_uuid_example' # String | ID of a user. Find a user's ID from `/users/entities/user/v1`.
body = Falcon::DomainUpdateUserFields.new # DomainUpdateUserFields | Attributes for this user. All attributes (shown below) are optional.

begin
  # Deprecated : Please use PATCH /user-management/entities/users/v1. Modify an existing user's first or last name
  result = api_instance.update_user(user_uuid, body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->update_user: #{e}"
end

Using the update_user_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_user_with_http_info(user_uuid, body)

begin
  # Deprecated : Please use PATCH /user-management/entities/users/v1. Modify an existing user's first or last name
  data, status_code, headers = api_instance.update_user_with_http_info(user_uuid, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiUserMetadataResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->update_user_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
user_uuid String ID of a user. Find a user's ID from `/users/entities/user/v1`.
body DomainUpdateUserFields Attributes for this user. All attributes (shown below) are optional.

Return type

ApiUserMetadataResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

update_user_v1

update_user_v1(user_uuid, body)

Modify an existing user's first or last name.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
user_uuid = 'user_uuid_example' # String | user uuid
body = Falcon::DomainUpdateUserRequest.new # DomainUpdateUserRequest | Both firstName and lastName have to specified.

begin
  # Modify an existing user's first or last name.
  result = api_instance.update_user_v1(user_uuid, body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->update_user_v1: #{e}"
end

Using the update_user_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_user_v1_with_http_info(user_uuid, body)

begin
  # Modify an existing user's first or last name.
  data, status_code, headers = api_instance.update_user_v1_with_http_info(user_uuid, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FlightcontrolapiUserResponse>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->update_user_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
user_uuid String user uuid
body DomainUpdateUserRequest Both firstName and lastName have to specified.

Return type

FlightcontrolapiUserResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

user_action_v1

user_action_v1(body)

Apply actions to one or more User. Available action names: reset_2fa, reset_password. User UUIDs can be provided in ids param as part of request payload.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
body = Falcon::DomainUserActionRequest.new({action: Falcon::DomainUserAction.new({action_name: 'reset_password'}), ids: ['ids_example']}) # DomainUserActionRequest | User UUIDs and Action Name params are required. Allowed values for Action Name param includes 'reset_2fa' and 'reset_password'

begin
  # Apply actions to one or more User. Available action names: reset_2fa, reset_password. User UUIDs can be provided in `ids` param as part of request payload.
  result = api_instance.user_action_v1(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->user_action_v1: #{e}"
end

Using the user_action_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> user_action_v1_with_http_info(body)

begin
  # Apply actions to one or more User. Available action names: reset_2fa, reset_password. User UUIDs can be provided in `ids` param as part of request payload.
  data, status_code, headers = api_instance.user_action_v1_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaspecResponseFields>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->user_action_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body DomainUserActionRequest User UUIDs and Action Name params are required. Allowed values for Action Name param includes 'reset_2fa' and 'reset_password'

Return type

MsaspecResponseFields

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

user_roles_action_v1

user_roles_action_v1(body)

Grant or Revoke one or more role(s) to a user against a CID. User UUID, CID and Role ID(s) can be provided in request payload. Available Action(s) : grant, revoke

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::UserManagement.new
body = Falcon::DomainActionUserRolesRequest.new # DomainActionUserRolesRequest | All fields including CID, RoleID(s), User UUID and Action are required. Allowed values for Action param include 'grant' and 'revoke'.

begin
  # Grant or Revoke one or more role(s) to a user against a CID. User UUID, CID and Role ID(s) can be provided in request payload. Available Action(s) : grant, revoke
  result = api_instance.user_roles_action_v1(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->user_roles_action_v1: #{e}"
end

Using the user_roles_action_v1_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> user_roles_action_v1_with_http_info(body)

begin
  # Grant or Revoke one or more role(s) to a user against a CID. User UUID, CID and Role ID(s) can be provided in request payload. Available Action(s) : grant, revoke
  data, status_code, headers = api_instance.user_roles_action_v1_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaspecResponseFields>
rescue Falcon::ApiError => e
  puts "Error when calling UserManagement->user_roles_action_v1_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
body DomainActionUserRolesRequest All fields including CID, RoleID(s), User UUID and Action are required. Allowed values for Action param include 'grant' and 'revoke'.

Return type

MsaspecResponseFields

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json