API docs by Redocly

User Tenant Association integration API (0.0.1)

User Tenant Association integration API

Get a list of user tenant associations

User Tenant Associations

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

query Parameters
userId
string <uuid> (uuid)

The UUID of the user

username
string

The username of the user

tenantId
string

The ID of the tenant

offset
integer [ 0 .. 2147483647 ]
Default: 0

Skip over a number of elements by specifying an offset value for the query

limit
integer [ 0 .. 2147483647 ]
Default: 100

Limit the number of elements returned in the response

Responses

Response samples

Content type
application/json
{
  • "userTenants": [
    ],
  • "totalRecords": 0
}

Inserts a single user_tenant associations

User Tenant Associations

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

Request Body schema: application/json
required

user_tenant object

id
string <uuid>
userId
required
string <uuid>
username
string
tenantId
required
string
tenantName
string
isPrimary
boolean
centralTenantId
string
consortiumId
string <uuid>
email
string
mobilePhoneNumber
string
phoneNumber
string

Responses

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "username": "string",
  • "tenantId": "string",
  • "tenantName": "string",
  • "isPrimary": true,
  • "centralTenantId": "string",
  • "consortiumId": "efa17688-681e-49fa-a2c1-b191cca6bafc",
  • "email": "string",
  • "mobilePhoneNumber": "string",
  • "phoneNumber": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "username": "string",
  • "tenantId": "string",
  • "tenantName": "string",
  • "isPrimary": true,
  • "centralTenantId": "string",
  • "consortiumId": "efa17688-681e-49fa-a2c1-b191cca6bafc",
  • "email": "string",
  • "mobilePhoneNumber": "string",
  • "phoneNumber": "string"
}

Delete User Tenant Association by user id and tenant id

Delete User Tenant Associations for particular user id and tenant id

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

query Parameters
userId
string <uuid> (uuid)

The UUID of the user

tenantId
required
string

The ID of the tenant

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "type": "string",
  • "code": "string",
  • "parameters": [
    ]
}

Get a list of user tenant associations by association id

path Parameters
consortiumId
required
string <uuid> (uuid)

The ID of consortium

associationId
required
string <uuid> (uuid)

UUID of the user to get and associated tenants.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "username": "string",
  • "tenantId": "string",
  • "tenantName": "string",
  • "isPrimary": true,
  • "centralTenantId": "string",
  • "consortiumId": "efa17688-681e-49fa-a2c1-b191cca6bafc",
  • "email": "string",
  • "mobilePhoneNumber": "string",
  • "phoneNumber": "string"
}