Get project public profile
GET/projectProfiles/{publicAlias}
Base URL: https://api.tinkermode.com
Get the publicly available information about a project. This includes information that is needed for a frontend application to carry out the user sign-in or sign-up process.
Authentication
This endpoint does not require authentication.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
publicAlias | string | Yes | A unique identifier to look up a profile's public profile. |
Responses
200 Project's public profile is returned.
Content type: application/json
| 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'. | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
401 Authorization is required to access this resource.
Content type: application/json
| 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. |
403 Request failed because of denied permission.
Content type: application/json
| 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. |
404 The requested projectProfile does not exist or is not accessible.
Content type: application/json
| 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. |
429 Request failed because of rate limit.
Content type: application/json
| 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. |
500 An unexpected error has occurred.
Content type: application/json
| 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. |
503 The service is temporarily unavailable.
Content type: application/json
| 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. |