Project Public Profiles data models
getProjectPublicProfile — 200 response
Project's public profile is returned.
| Property | Type | Required | Constraints | Description | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
alertingVersion | integer | No | read-only (server-generated); one of: 1, 2 | Alerting version for the project. Omitted/1 = V1, 2 = V2. | |||||||||||||||||||||||||||||||||||
allowEntityClassPermissions | boolean | No | read-only (server-generated) | If true, entity class permissions are allowed for the project. | |||||||||||||||||||||||||||||||||||
assistantMode | integer | No | default: 0 | Describes the AI Assistant feature mode. 0 means the feature is disabled. | |||||||||||||||||||||||||||||||||||
description | string | Yes | read-only (server-generated) | A short description of the project. | |||||||||||||||||||||||||||||||||||
disableEntityMapping | boolean | No | read-only (server-generated) | If true, entity mapping is disabled for the project. | |||||||||||||||||||||||||||||||||||
enableDeviceLogRetrieval | boolean | No | read-only (server-generated) | True to enable device log retrieval. | |||||||||||||||||||||||||||||||||||
id | integer | Yes | read-only (server-generated) | Unique project ID. | |||||||||||||||||||||||||||||||||||
locale | string | No | read-only (server-generated) | Default locale that can be used by project's frontend apps. | |||||||||||||||||||||||||||||||||||
name | string | Yes | read-only (server-generated) | Display name of project. | |||||||||||||||||||||||||||||||||||
onDemandProvisioning | boolean | No | read-only (server-generated) | True if devices are provisioned on demand by users. | |||||||||||||||||||||||||||||||||||
publicAlias | string | No | read-only (server-generated) | Lookup key associated with project's public profile. | |||||||||||||||||||||||||||||||||||
restrictPasswordLogin | boolean | No | If true, login by password is not allowed for regular users. | ||||||||||||||||||||||||||||||||||||
restrictUserReg | boolean | No | read-only (server-generated) | True to turn off open user registration. | |||||||||||||||||||||||||||||||||||
userAccountMode | string | Yes | read-only (server-generated); one of: phone, email, byou | Determines how the user account system should operate. | |||||||||||||||||||||||||||||||||||
userPasswordPolicy | object | No | read-only (server-generated) | Password policy for project's users. Applicable only if userAccountMode is 'email'. | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
getProjectPublicProfile — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getProjectPublicProfile — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getProjectPublicProfile — 404 response
The requested projectProfile does not exist or is not accessible.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getProjectPublicProfile — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getProjectPublicProfile — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getProjectPublicProfile — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getConfigurationApp — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getConfigurationApp — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getConfigurationApp — 404 response
The requested config does not exist or is not accessible.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getConfigurationApp — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getConfigurationApp — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getConfigurationApp — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
listAlternativeUserAuthenticationMethods — 200 response
Authentication methods are returned.
A client authentication method (such as one using OpenID Connect).
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
config | object | No | Configuration key-value pairs, whose specific structure depends on the protocol of this method. This field is only present to authorized administrators. | |
description | string | No | Additional info about this method. | |
iconUrl | string | No | URL to an icon image to represent this method on UI. | |
id | string | Yes | read-only (server-generated) | Identifier assigned to the method. |
label | string | Yes | String to be displayed on UI to represent this method. | |
protocol | string | Yes | one of: oidc | The protocol to be used with this method. |
listAlternativeUserAuthenticationMethods — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
listAlternativeUserAuthenticationMethods — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
listAlternativeUserAuthenticationMethods — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
listAlternativeUserAuthenticationMethods — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
listAlternativeUserAuthenticationMethods — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getUserAuthenticationMethod — 200 response
Authentication method is returned.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
config | object | No | Configuration key-value pairs, whose specific structure depends on the protocol of this method. This field is only present to authorized administrators. | |
description | string | No | Additional info about this method. | |
iconUrl | string | No | URL to an icon image to represent this method on UI. | |
id | string | Yes | read-only (server-generated) | Identifier assigned to the method. |
label | string | Yes | String to be displayed on UI to represent this method. | |
protocol | string | Yes | one of: oidc | The protocol to be used with this method. |
getUserAuthenticationMethod — 401 response
Authorization is required to access this resource.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getUserAuthenticationMethod — 403 response
Request failed because of denied permission.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getUserAuthenticationMethod — 404 response
The requested userAuthMethod does not exist or is not accessible.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getUserAuthenticationMethod — 429 response
Request failed because of rate limit.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getUserAuthenticationMethod — 500 response
An unexpected error has occurred.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
getUserAuthenticationMethod — 503 response
The service is temporarily unavailable.
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |