Identity Users API

Accounts

Reference material for usage on Identity (IAM) > Users.

GET

/v1/users

(identity)

List user accounts.

Service
identity

Accepted Roles (RBAC)

AdministratorCustomerIdentity AdministratorIdentity SupportStaff MemberSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
id	query	string	Filter by id. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
name	query	string	Filter by name. (can suffix with wildcard )*
org_name	query	string	Filter by org_name. (can suffix with wildcard )*
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (id, name, username, org_name)
sd	query	string	Sort direction. asc for Ascending or desc for Descending
username	query	string	Filter by username. (can suffix with wildcard )*

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
address_line1	body	string	Address Line1.
address_line2	body	string	Address Line2.
address_line3	body	string	Address Line3.
address_line4	body	string	Address Line4.
country	body	string	Country.
domain	body	string	Entity Domain.
email	body	string	Email.
enabled	body	boolean	Enabled.
id	body	string	Unique Entity ID.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)
name	body	string	Name of Entity.
org_name	body	string	Org Name.
phone_home	body	string	Phone Home.
phone_mobile	body	string	Phone Mobile.
phone_office	body	string	Phone Office.
postal_code	body	string	Postal Code.
state	body	string	State.
tenant_id	body	string	Entity Tenant.
timezone	body	string	Timezone.
username	body	string	Username.

Response Example

{
    "payload": [
        {
            "id": "eec35dc4-2317-11ef-a800-4f09eded88c9",
            "domain": "interstellio.io",
            "tenant_id": null,
            "username": "test@interstellio.io",
            "name": "Test User Account",
            "org_name": "Test Company",
            "address_line1": null,
            "address_line2": null,
            "address_line3": null,
            "address_line4": null,
            "postal_code": null,
            "country": "ZA",
            "state": null,
            "email": "guy@interstellio.io",
            "phone_home": null,
            "phone_mobile": null,
            "phone_office": null,
            "enabled": true,
            "timezone": null,
            "creation_time": "2024-06-05T08:45:16.000Z",
            "mfa": false
        }
    ],
    "metadata": {
        "records": 1,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v1/user/{user_id}

(identity)

View user account.

Service
identity

Accepted Roles (RBAC)

AdministratorCustomerIdentity AdministratorIdentity SupportStaff MemberSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
user_id	url	string	User Id.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
address_line1	body	string	Address Line1.
address_line2	body	string	Address Line2.
address_line3	body	string	Address Line3.
address_line4	body	string	Address Line4.
country	body	string	Country.
domain	body	string	Entity Domain.
email	body	string	Email.
enabled	body	boolean	Enabled.
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.
org_name	body	string	Org Name.
phone_home	body	string	Phone Home.
phone_mobile	body	string	Phone Mobile.
phone_office	body	string	Phone Office.
postal_code	body	string	Postal Code.
state	body	string	State.
tenant_id	body	string	Entity Tenant.
timezone	body	string	Timezone.
username	body	string	Username.

Response Example

{
    "id": "eec35dc4-2317-11ef-a800-4f09eded88c9",
    "domain": "interstellio.io",
    "tenant_id": null,
    "username": "test@interstellio.io",
    "name": "Test User Account",
    "org_name": "Test Company",
    "address_line1": null,
    "address_line2": null,
    "address_line3": null,
    "address_line4": null,
    "postal_code": null,
    "country": "ZA",
    "state": null,
    "email": "guy@interstellio.io",
    "phone_home": null,
    "phone_mobile": null,
    "phone_office": null,
    "enabled": true,
    "timezone": null,
    "creation_time": "2024-06-05T08:45:16.000Z",
    "mfa": false
}

POST

/v1/user

(identity)

Create a new user account.

Service
identity

Accepted Roles (RBAC)

AdministratorIdentity Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
address_line1	body	string	Address Line1.
address_line2	body	string	Address Line2.
address_line3	body	string	Address Line3.
address_line4	body	string	Address Line4.
country	body	string	Country.	X
email	body	string	Email.	X
enabled	body	boolean	Enabled.	X
name	body	string	Name of Entity.
org_name	body	string	Org Name.
phone_home	body	string	Phone Home.
phone_mobile	body	string	Phone Mobile.
phone_office	body	string	Phone Office.
postal_code	body	string	Postal Code.
state	body	string	State.
timezone	body	string	Timezone.
username	body	string	Username.	X

Request Example

{
    "username": "test@interstellio.io",
    "name": "Test User Account",
    "org_name": "Test Company",
    "country": "ZA",
    "email": "guy@interstellio.io",
    "enabled": true
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
address_line1	body	string	Address Line1.
address_line2	body	string	Address Line2.
address_line3	body	string	Address Line3.
address_line4	body	string	Address Line4.
country	body	string	Country.
domain	body	string	Entity Domain.
email	body	string	Email.
enabled	body	boolean	Enabled.
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.
org_name	body	string	Org Name.
phone_home	body	string	Phone Home.
phone_mobile	body	string	Phone Mobile.
phone_office	body	string	Phone Office.
postal_code	body	string	Postal Code.
state	body	string	State.
tenant_id	body	string	Entity Tenant.
timezone	body	string	Timezone.
username	body	string	Username.

Response Example

{
    "id": "eec35dc4-2317-11ef-a800-4f09eded88c9",
    "domain": "interstellio.io",
    "tenant_id": null,
    "username": "test@interstellio.io",
    "name": "Test User Account",
    "org_name": "Test Company",
    "address_line1": null,
    "address_line2": null,
    "address_line3": null,
    "address_line4": null,
    "postal_code": null,
    "country": "ZA",
    "state": null,
    "email": "guy@interstellio.io",
    "phone_home": null,
    "phone_mobile": null,
    "phone_office": null,
    "enabled": true,
    "timezone": null,
    "creation_time": "2024-06-05T08:45:16.000Z",
    "mfa": false
}

PATCH

/v1/user/{user_id}

(identity)

Update user account.

Service
identity

Accepted Roles (RBAC)

AdministratorIdentity Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
user_id	url	string	User Id.	X
address_line1	body	string	Address Line1.
address_line2	body	string	Address Line2.
address_line3	body	string	Address Line3.
address_line4	body	string	Address Line4.
country	body	string	Country.	X
email	body	string	Email.	X
enabled	body	boolean	Enabled.	X
name	body	string	Name of Entity.
org_name	body	string	Org Name.
phone_home	body	string	Phone Home.
phone_mobile	body	string	Phone Mobile.
phone_office	body	string	Phone Office.
postal_code	body	string	Postal Code.
state	body	string	State.
timezone	body	string	Timezone.
username	body	string	Username.	X

Request Example

{
    "name": "Test User Account",
    "org_name": "Test Company",
    "country": "ZA",
    "email": "guy@interstellio.io",
    "enabled": true
}

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
address_line1	body	string	Address Line1.
address_line2	body	string	Address Line2.
address_line3	body	string	Address Line3.
address_line4	body	string	Address Line4.
country	body	string	Country.
domain	body	string	Entity Domain.
email	body	string	Email.
enabled	body	boolean	Enabled.
id	body	string	Unique Entity ID.
name	body	string	Name of Entity.
org_name	body	string	Org Name.
phone_home	body	string	Phone Home.
phone_mobile	body	string	Phone Mobile.
phone_office	body	string	Phone Office.
postal_code	body	string	Postal Code.
state	body	string	State.
tenant_id	body	string	Entity Tenant.
timezone	body	string	Timezone.
username	body	string	Username.

Response Example

{
    "id": "eec35dc4-2317-11ef-a800-4f09eded88c9",
    "domain": "interstellio.io",
    "tenant_id": null,
    "username": "test@interstellio.io",
    "name": "Test User Account",
    "org_name": "Test Company",
    "address_line1": null,
    "address_line2": null,
    "address_line3": null,
    "address_line4": null,
    "postal_code": null,
    "country": "ZA",
    "state": null,
    "email": "guy@interstellio.io",
    "phone_home": null,
    "phone_mobile": null,
    "phone_office": null,
    "enabled": true,
    "timezone": null,
    "creation_time": "2024-06-05T08:45:16.000Z",
    "mfa": false
}

DELETE

/v1/user/{user_id}

(identity)

Delete user account.

Service
identity

Accepted Roles (RBAC)

AdministratorIdentity Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
user_id	url	string	User Id.	X

Response Status Codes

Code	Meaning
204	OK - No Content
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Assignments

Reference material for usage on Identity (IAM) > Assignments.

GET

/v1/user/{user_id}/assignments

(identity)

List Assignments.

Service
identity

Accepted Roles (RBAC)

AdministratorCustomerIdentity AdministratorIdentity SupportStaff MemberSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
user_id	url	string	User Id.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
creation_time	body	string	Creation Time.
domain	body	string	Entity Domain.
role	body	string	Role.
tenant_id	body	string	Entity Tenant.
user_id	body	string	User Id.

Response Example

[
    {
        "role": "Root",
        "domain": "any",
        "tenant_id": "any",
        "user_id": "2ff214b6-0847-11ef-9641-33404d9d7364",
        "creation_time": "2024-05-02T05:45:48.000Z"
    }
]

POST

/v1/user/{user_id}/assignment/{role}/{domain}/{tenant_id}

(identity)

Add assignment.

Service
identity

Accepted Roles (RBAC)

AdministratorIdentity Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
domain	url	string	Domain name or alternatively 'any'	X
role	url	string	Role name.	X
tenant_id	url	string	Tenant-ID or alternatively 'any'	X
user_id	url	string	User Id.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

DELETE

/v1/user/{user_id}/assignment/{role}/{domain}/{tenant_id}

(identity)

Remove assignment.

Service
identity

Accepted Roles (RBAC)

AdministratorIdentity Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Tenant-ID	header	string	Request Tenant Context.
domain	url	string	Domain name or alternatively 'any'	X
role	url	string	Role name.	X
tenant_id	url	string	Tenant-ID or alternatively 'any'	X
user_id	url	string	User Id.	X

Response Status Codes

Code	Meaning
204	OK - No Content
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Navigation

Identity Users API

Accounts

Assignments