User Management

Using the User Management service collection

Table of Contents

Operation ID	Description
GetRoles PEP 8 get_roles	Get info about a role
GrantUserRoleIds PEP 8 grant_user_role_ids	Assign one or more roles to a user
RevokeUserRoleIds PEP 8 revoke_user_role_ids	Revoke one or more roles from a user
GetAvailableRoleIds PEP 8 get_available_role_ids	Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to GetRole.
GetUserRoleIds PEP 8 get_user_role_ids	Show role IDs of roles assigned to a user. For more information on each role, provide the role ID to GetRole.
RetrieveUser PEP 8 retrieve_user	Get info about a user
CreateUser PEP 8 create_user	Create a new user. After creating a user, assign one or more roles with CreateUser
DeleteUser PEP 8 delete_user	Delete a user permanently
UpdateUser PEP 8 update_user	Modify an existing user's first or last name
RetrieveEmailsByCID PEP 8 retrieve_emails_by_cid	List the usernames (usually an email address) for all users in your customer account
RetrieveUserUUIDsByCID PEP 8 retrieve_user_uuids_by_cid	List user IDs for all users in your customer account. For more information on each user, provide the user ID to RetrieveUser.
RetrieveUserUUID PEP 8 retrieve_user_uuid	Get a user's ID by providing a username (usually an email address)

GetRoles

Get info about a role

PEP8 method name

get_roles

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
ids			query	string or list of strings	ID of a role. Find a role ID from GetAvailableRoleIds or GetUserRoleIds.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_roles(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.GetRoles(ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("GetRoles", ids=id_list)
print(response)

GrantUserRoleIds

Assign one or more roles to a user

PEP8 method name

grant_user_role_ids

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
body			body	string	Role ID(s) of the role you want to assign.
parameters			query	string	Full query string parameters payload in JSON format.
role_ids			body	string or list of strings	Role ID(s) of the role you want to assign. Can also use the keyword roleIds.
user_uuid			query	string	ID of a user. Find a user's ID using RetrieveUserUUID.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.grant_user_role_ids(user_uuid="string", role_ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.GrantUserRoleIds(user_uuid="string", role_ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

BODY = {
    "roleIds": [
        "string"
    ]
}

response = falcon.command("GrantUserRoleIds", user_uuid="string", body=BODY)
print(response)

RevokeUserRoleIds

Revoke one or more roles from a user

PEP8 method name

revoke_user_role_ids

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
parameters			query	string	Full query string parameters payload in JSON format.
ids			query	string or list of strings	One or more role IDs to revoke. Find a role's ID using GetAvailableRoleIds.
user_uuid			query	string	ID of a user. Find a user's ID using RetrieveUserUUID.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.revoke_user_role_ids(user_uuid="string", ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.RevokeUserRoleIds(user_uuid="string", ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("RevokeUserRoleIds", user_uuid="string", ids=id_list)
print(response)

GetAvailableRoleIds

Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to GetRoles.

PEP8 method name

get_available_role_ids

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

No keywords or arguments accepted.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.get_available_role_ids()
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.GetAvailableRoleIds()
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("GetAvailableRoleIds")
print(response)

GetUserRoleIds

Show role IDs of roles assigned to a user. For more information on each role, provide the role ID to GetRoles.

PEP8 method name

get_user_role_ids

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
parameters			query	string	Full query string parameters payload in JSON format.
user_uuid			query	string	ID of a user. Find a user's ID using RetrieveUserUUID.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.get_user_role_ids(user_uuid="string")
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.GetUserRoleIds(user_uuid="string")
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("GetUserRoleIds", user_uuid="string")
print(response)

RetrieveUser

Get info about a user

PEP8 method name

retrieve_user

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
parameters			query	string	Full query string parameters payload in JSON format.
ids			query	string or list of strings	ID of a user. Find a user's ID using RetrieveUserUUID.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.retrieve_user(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.RetrieveUser(ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("RetrieveUser", ids=id_list)
print(response)

CreateUser

Create a new user. After creating a user, assign one or more roles with GrantUserRoleIds.

PEP8 method name

create_user

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
body			body	string	Attributes for this user. uid (required) is the user's email address, which is their username in Falcon. Optional attributes: firstName lastName password 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.
first_name			body	string	First name of the user. (Can also use the keyword firstName.)
last_name			body	string	Last name of the user. (Can also use the keyword lastName.)
password			body	string	Assigned password. String. As a best practice, we recommend ommitting 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.
uid			body	string	The user's email address, which will be the assigned username.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.create_user(first_name="string",
                              last_name="string",
                              uid="[email protected]"
                              )
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.CreateUser(first_name="string",
                             last_name="string",
                             uid="[email protected]"
                             )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

BODY = {
    "firstName": "string",
    "lastName": "string",
    "password": "string",
    "uid": "[email protected]"
}

response = falcon.command("CreateUser", body=BODY)
print(response)

DeleteUser

Delete a user permanently

PEP8 method name

delete_user

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
parameters			query	string	Full query string parameters payload in JSON format.
user_uuid			query	string	ID of a user. Find a user's ID using RetrieveUserUUID.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.delete_user(user_uuid="string")
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.DeleteUser(user_uuid="string")
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("DeleteUser", user_uuid="string")
print(response)

UpdateUser

Modify an existing user's first or last name

PEP8 method name

update_user

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
body			body	string	Full body payload in JSON format.
first_name			body	string	First name of the user. (Can also use the keyword firstName.)
last_name			body	string	Last name of the user. (Can also use the keyword lastName.)
parameters			query	string	Full query string parameters payload in JSON format.
user_uuid			query	string	The user ID to modify.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.update_user(user_uuid="string",
                             first_name="string",
                             last_name="string"
                             )
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.UpdateUser(user_uuid="string",
                             first_name="string",
                             last_name="string"
                             )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

BODY = {
    "firstName": "string",
    "lastName": "string"
}

response = falcon.command("UpdateUser", user_uuid="string", body=BODY)
print(response)

RetrieveEmailsByCID

List the usernames (usually an email address) for all users in your customer account

PEP8 method name

retrieve_emails_by_cid

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

No keywords or arguments accepted.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.retrieve_emails_by_cid()
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.RetrieveEmailsByCID()
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("RetrieveEmailsByCID")
print(response)

RetrieveUserUUIDsByCID

List user IDs for all users in your customer account. For more information on each user, provide the user ID to RetrieveUser.

PEP8 method name

retrieve_user_uuids_by_cid

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

No keywords or arguments accepted.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.retrieve_user_uuids_by_cid()
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

response = falcon.RetrieveUserUUIDsByCID()
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("RetrieveUserUUIDsByCID")
print(response)

RetrieveUserUUID

Get a user's ID by providing a username (usually an email address)

PEP8 method name

retrieve_user_uuid

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Datatype	Description
parameters			query	string	Full query string parameters payload in JSON format.
uid			query	string or list of strings	List of User names to retrieve.

Usage

Service class example (PEP8 syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )
id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.retrieve_user_uuid(uid=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import UserManagement

falcon = UserManagement(client_id="API_CLIENT_ID_HERE",
                        client_secret="API_CLIENT_SECRET_HERE"
                        )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.RetrieveUserUUID(uid=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("RetrieveUserUUID", uid=id_list)
print(response)