Skip to main content

Core Resources

Architect core resources provide developers a closer look at what the specific request or value should represent by having organized and predictable definition names and their inital structures. Architect SDK and API currently provide developers a lot of flexible functionality and freedom to import and control their own resources.


ArchitectResource

object

Object representing your Architect resource. On top of your resource fields and types, Architect automatically injects important timestamps and special identification for that particular resource.


id string

Unique ID representing your resource.

createdAt string

Date resembling time of resource creation.

updatedAt string

Date resembling last recorded resource update.

Example
{
"id": "<YOUR_RESOURCE_ID>",
"createdAt": "<CREATION_DATE>",
"updatedAt": "<UPDATE_DATE>",
/* Your resource data */
}

ArchitectAuthProvider

enum

Providers available for authentication. Each of the following providers have their own unique authentication methods which you use to successfully authenticate given user.


email

facebook

google

apple

ArchitectCredentials

type

Type containing different unique authentication methods that are different for each given provider. Following authentication methods are given:


EmailCredentials

object

Object containing fields needed for authentication with email provider.


email string

password string

Example
{
"email": "test@example.com",
"password": "<YOUR_PASSWORD>"
}

FacebookCredentials

object

Object containing fields needed for authentication with Facebook provider.


accessToken string

Example
{
"accessToken": "<YOUR_ACCESS_TOKEN>",
}

GoogleCredentials

object

Object containing fields needed for authentication with Google provider.


idToken string

Example
{
"idToken": "<YOUR_ID_TOKEN>",
}

AppleCredentials

object

Object containing fields needed for authentication with Apple provider.


identityToken string

Example
{
"identityToken": "<YOUR_IDENTITY_TOKEN>",
}

ArchitectFileResource

object

Object containing source location of uploaded content.


url string

URL representing uploaded content location.

Example
{
"url": "<CONTENT_LOCATION>",
}

ArchitectAuthResponse

object

Object containing given user data.


id number

Unique ID representing a user.

role string

Role defines the functionality that a user has access to.

email string

apple_id string

facebook_id string

google_id string

active boolean

details object

authorization object

Object containing authorization token.

Example
{
"id": 1,
"role": "regular",
"email":"user@demo.com",
"apple_id": "YYYYYYYYYY",
"facebook_id": "YYYYYYYYYY",
"google_id": "YYYYYYYYYY",
"active": true,
"details": {},
"authorization": {
"token": "eyJhbGc...."
}
}

ArchitectAuthObject

object

Object containing fields needed for authentication.


ArchitectCredentials

Fields needed for authentication with a certain provider.

provider ArchitectAuthProvider #

Provider for successful authentication.

Example
{
ArchitectCredentials,
"provider": ArchitectAuthProvider
}