Identity Tenants API

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

GET

/v1/tenants

(identity)

List tenant 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, tenantname, org_name)
sd	query	string	Sort direction. asc for Ascending or desc for Descending
tenantname	query	string	Filter by tenantname. (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.
id_no	body	string	Id No.
id_type	body	string	Id Type.
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.
org_reg	body	string	Org Reg.
phone_home	body	string	Phone Home.
phone_mobile	body	string	Phone Mobile.
phone_office	body	string	Phone Office.
postal_code	body	string	Postal Code.
short_id	body	string	Short Id.
state	body	string	State.
vat_reg	body	string	Vat Reg.

Response Example

{
    "payload": [
        {
            "id": "f347ba74-7a67-402e-816b-20c53183a867",
            "short_id": "YINI-PSQY-ITQB",
            "domain": "interstellio.io",
            "name": "Test Customer",
            "address_line1": "Googleplex",
            "address_line2": "Mountain View",
            "address_line3": null,
            "address_line4": null,
            "postal_code": "650",
            "country": "United States",
            "state": "California",
            "email": "chris@fwiw.co.za",
            "phone_home": "+1 555 111 1234",
            "phone_mobile": "+1 555 111 1234",
            "phone_office": "+1 555 111 1234",
            "org_reg": null,
            "vat_reg": null,
            "id_no": null,
            "id_type": null,
            "metadata": {},
            "creation_time": "2020-04-27T08:53:03.000Z",
            "enabled": true
        }
    ],
    "metadata": {
        "records": 1,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v1/tenant/{tenant_id}

(identity)

View tenant 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)
tenant_id	url	string	Tenant 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.
id_no	body	string	Id No.
id_type	body	string	Id Type.
name	body	string	Name of Entity.
org_name	body	string	Org Name.
org_reg	body	string	Org Reg.
phone_home	body	string	Phone Home.
phone_mobile	body	string	Phone Mobile.
phone_office	body	string	Phone Office.
postal_code	body	string	Postal Code.
short_id	body	string	Short Id.
state	body	string	State.
vat_reg	body	string	Vat Reg.

Response Example

{
    "id": "f347ba74-7a67-402e-816b-20c53183a867",
    "short_id": "YINI-PSQY-ITQB",
    "domain": "interstellio.io",
    "name": "Test Customer",
    "address_line1": "Googleplex",
    "address_line2": "Mountain View",
    "address_line3": null,
    "address_line4": null,
    "postal_code": "650",
    "country": "United States",
    "state": "California",
    "email": "chris@fwiw.co.za",
    "phone_home": "+1 555 111 1234",
    "phone_mobile": "+1 555 111 1234",
    "phone_office": "+1 555 111 1234",
    "org_reg": null,
    "vat_reg": null,
    "id_no": null,
    "id_type": null,
    "metadata": {},
    "creation_time": "2020-04-27T08:53:03.000Z",
    "enabled": true
}

POST

/v1/tenant

(identity)

Create a new tenant 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.
enabled	body	boolean	Enabled.	X
id_no	body	string	Id No.
id_type	body	string	Id Type.
name	body	string	Name of Entity.	X
org_name	body	string	Org Name.
org_reg	body	string	Org Reg.
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.
vat_reg	body	string	Vat Reg.

Request Example

{
    "name": "Test Customer",
    "address_line1": "Googleplex",
    "address_line2": "Mountain View",
    "postal_code": "650",
    "country": "United States",
    "state": "California",
    "email": "chris@fwiw.co.za",
    "phone_home": "+1 555 111 1234",
    "phone_mobile": "+1 555 111 1234",
    "phone_office": "+1 555 111 1234",
    "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.
id_no	body	string	Id No.
id_type	body	string	Id Type.
name	body	string	Name of Entity.
org_name	body	string	Org Name.
org_reg	body	string	Org Reg.
phone_home	body	string	Phone Home.
phone_mobile	body	string	Phone Mobile.
phone_office	body	string	Phone Office.
postal_code	body	string	Postal Code.
short_id	body	string	Short Id.
state	body	string	State.
vat_reg	body	string	Vat Reg.

Response Example

{
    "id": "f347ba74-7a67-402e-816b-20c53183a867",
    "short_id": "YINI-PSQY-ITQB",
    "domain": "interstellio.io",
    "name": "Test Customer",
    "address_line1": "Googleplex",
    "address_line2": "Mountain View",
    "address_line3": null,
    "address_line4": null,
    "postal_code": "650",
    "country": "United States",
    "state": "California",
    "email": "chris@fwiw.co.za",
    "phone_home": "+1 555 111 1234",
    "phone_mobile": "+1 555 111 1234",
    "phone_office": "+1 555 111 1234",
    "org_reg": null,
    "vat_reg": null,
    "id_no": null,
    "id_type": null,
    "metadata": {},
    "creation_time": "2020-04-27T08:53:03.000Z",
    "enabled": true
}

PATCH

/v1/tenant/{tenant_id}

(identity)

Update tenant 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)
tenant_id	url	string	Tenant 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.
enabled	body	boolean	Enabled.	X
id_no	body	string	Id No.
id_type	body	string	Id Type.
name	body	string	Name of Entity.	X
org_name	body	string	Org Name.
org_reg	body	string	Org Reg.
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.
vat_reg	body	string	Vat Reg.

Request Example

{
    "name": "Test Customer",
    "address_line1": "Googleplex",
    "address_line2": "Mountain View",
    "postal_code": "650",
    "country": "United States",
    "state": "California",
    "email": "chris@fwiw.co.za",
    "phone_home": "+1 555 111 1234",
    "phone_mobile": "+1 555 111 1234",
    "phone_office": "+1 555 111 1234",
    "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.
id_no	body	string	Id No.
id_type	body	string	Id Type.
name	body	string	Name of Entity.
org_name	body	string	Org Name.
org_reg	body	string	Org Reg.
phone_home	body	string	Phone Home.
phone_mobile	body	string	Phone Mobile.
phone_office	body	string	Phone Office.
postal_code	body	string	Postal Code.
short_id	body	string	Short Id.
state	body	string	State.
vat_reg	body	string	Vat Reg.

Response Example

{
    "id": "f347ba74-7a67-402e-816b-20c53183a867",
    "short_id": "YINI-PSQY-ITQB",
    "domain": "interstellio.io",
    "name": "Test Customer",
    "address_line1": "Googleplex",
    "address_line2": "Mountain View",
    "address_line3": null,
    "address_line4": null,
    "postal_code": "650",
    "country": "United States",
    "state": "California",
    "email": "chris@fwiw.co.za",
    "phone_home": "+1 555 111 1234",
    "phone_mobile": "+1 555 111 1234",
    "phone_office": "+1 555 111 1234",
    "org_reg": null,
    "vat_reg": null,
    "id_no": null,
    "id_type": null,
    "metadata": {},
    "creation_time": "2020-04-27T08:53:03.000Z",
    "enabled": true
}

DELETE

/v1/tenant/{tenant_id}

(identity)

Delete tenant 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.
tenant_id	url	string	Tenant 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 Tenants API