Schemas

Download schema

UserRole

string · enum

Enum values:

USER

ADMIN

SupportedLanguage

string · enum

Enum values:

en-GB

Country

string · enum

Enum values:

Afghanistan

Albania

Algeria

Andorra

Angola

Antigua and Barbuda

Argentina

Armenia

Locale

string · enum

Enum values:

ar-AE

ar-BH

ar-DJ

ar-DZ

ar-EG

ar-EH

ar-ER

TimeZone

string · enum

Enum values:

Africa/Abidjan

Africa/Accra

Africa/Addis_Ababa

Africa/Algiers

Africa/Asmera

Africa/Bamako

Africa/Bangui

Africa/Banjul

BackendApplicationType

string · enum

Enum values:

DAM

LLM

StudioRole

string · enum

Enum values:

USER

ADMIN

StudioSpaceRole

string · enum

Enum values:

VIEWER

CONTRIBUTOR

MANAGER

ADMIN

SpaceUserCreate

spaceId

string · required

spaceRole

string · enum · required

Enum values:

VIEWER

CONTRIBUTOR

MANAGER

ADMIN

isDefault

boolean

Whether this space is the user's default

UserStudioSettingsWithSpaces

role

string · enum · required

Enum values:

USER

ADMIN

defaultSpaceRole

string · enum

Enum values:

VIEWER

CONTRIBUTOR

MANAGER

ADMIN

object[]

AvaRole

string · enum

Enum values:

USER

MANAGER

ADMIN

UserAvaSettings

role

string · enum · required

Enum values:

USER

MANAGER

ADMIN

UserCreateRequest

emailAddress

string · minLength: 2 · maxLength: 256 · required

Email address must be unique.

firstName

string · minLength: 2 · maxLength: 256 · required

lastName

string · minLength: 2 · maxLength: 256 · required

role

string · enum · required

The role of the user. Admins have access to the Aforza Admin Portal (https://admin.aforza.com)

Enum values:

USER

ADMIN

backendApplications

string[] · minItems: 0 · unique · required

A list of applications the user has access to. DAM = Aforza Studio, LLM = Ava

Enum values:

DAM

LLM

salesforceUserId

string · minLength: 18 · maxLength: 18

The Salesforce user ID of the user. Must be 18 characters long.

language

string · enum

Enum values:

en-GB

country

string · enum

Enum values:

Afghanistan

Albania

Algeria

Andorra

Angola

Antigua and Barbuda

Argentina

Armenia

locale

string · enum

Enum values:

ar-AE

ar-BH

ar-DJ

ar-DZ

ar-EG

ar-EH

ar-ER

timeZone

string · enum

Enum values:

Africa/Abidjan

Africa/Accra

Africa/Addis_Ababa

Africa/Algiers

Africa/Asmera

Africa/Bamako

Africa/Bangui

Africa/Banjul

object

Required if the user has access to Aforza Studio (backendApplications includes DAM)

Example: {"role":"USER","defaultSpaceRole":"VIEWER"}

object

Required if the user has access to Ava (backendApplications includes LLM)

Example: {"role":"USER"}

UserStatus

string · enum

Enum values:

PROVISIONED

ACTIVE

INACTIVE

DELETED

UserBackendApplication

status

string · enum · required

Enum values:

PROVISIONED

ACTIVE

INACTIVE

DELETED

userId

string

UserBackendApplications

object

UserStudioSettings

role

string · enum · required

Enum values:

USER

ADMIN

UserResponse

userId

string · readOnly · required

firstName

string · readOnly · required

lastName

string · readOnly · required

displayName

string · readOnly · required

emailAddress

string · readOnly · required

status

string · enum · readOnly · required

Enum values:

PROVISIONED

ACTIVE

INACTIVE

DELETED

role

string · enum · readOnly · required

Enum values:

USER

ADMIN

createdDate

string · date-time · readOnly · required

oktaUserId

string · readOnly · required

object · readOnly · required

avatarUrl

string · readOnly

language

string · enum · readOnly

Enum values:

en-GB

country

string · enum · readOnly

Enum values:

Afghanistan

Albania

Algeria

Andorra

Angola

Antigua and Barbuda

Argentina

Armenia

locale

string · enum · readOnly

Enum values:

ar-AE

ar-BH

ar-DJ

ar-DZ

ar-EG

ar-EH

ar-ER

timeZone

string · enum · readOnly

Enum values:

Africa/Abidjan

Africa/Accra

Africa/Addis_Ababa

Africa/Algiers

Africa/Asmera

Africa/Bamako

Africa/Bangui

Africa/Banjul

salesforceUserId

string · readOnly

object · readOnly

ErrorCode

string · enum

Enum values:

AVA_NOT_ENABLED

EMAIL_CONFLICT

NO_AVAILABLE_LICENCES

SALESFORCE_USER_ID_CONFLICT

STUDIO_NOT_ENABLED

STUDIO_SPACE_INFO_REQUIRED

THIRD_PARTY_EMAIL_CONFLICT

AVA_CONFIG_MISSING_REQUIRED_PROPERTIES

Field

string · enum

Enum values:

displayName

emailAddress

firstName

lastName

oktaUserId

salesforceUserId

status

role

ErrorResponse

statusCode

number · readOnly · required

error

string · readOnly · required

message

string · readOnly · required

errorCode

string · enum · readOnly

Enum values:

AVA_NOT_ENABLED

EMAIL_CONFLICT

NO_AVAILABLE_LICENCES

SALESFORCE_USER_ID_CONFLICT

STUDIO_NOT_ENABLED

STUDIO_SPACE_INFO_REQUIRED

THIRD_PARTY_EMAIL_CONFLICT

AVA_CONFIG_MISSING_REQUIRED_PROPERTIES

field

string · enum · readOnly

Enum values:

displayName

emailAddress

firstName

lastName

oktaUserId

salesforceUserId

status

role

UserField

string · enum

Enum values:

displayName

emailAddress

firstName

lastName

oktaUserId

salesforceUserId

status

role

UserResponsePaged

count

number · readOnly · required

The total number of users matching the query (not necessarily the number of users returned in items).

object[] · readOnly · required

UserUpdateRequest

emailAddress

string · minLength: 2 · maxLength: 256

firstName

string · minLength: 2 · maxLength: 256

lastName

string · minLength: 2 · maxLength: 256

role

string · enum

Enum values:

USER

ADMIN

salesforceUserId

null | string · minLength: 18 · maxLength: 18

language

string · enum

Enum values:

en-GB

country

string · enum

Enum values:

Afghanistan

Albania

Algeria

Andorra

Angola

Antigua and Barbuda

Argentina

Armenia

locale

string · enum

Enum values:

ar-AE

ar-BH

ar-DJ

ar-DZ

ar-EG

ar-EH

ar-ER

timeZone

string · enum

Enum values:

Africa/Abidjan

Africa/Accra

Africa/Addis_Ababa

Africa/Algiers

Africa/Asmera

Africa/Bamako

Africa/Bangui

Africa/Banjul

backendApplications

string[] · minItems: 1 · unique

Enum values:

DAM

LLM

object

UserCreateRequest

emailAddress

string · minLength: 2 · maxLength: 256 · required

Email address must be unique.

firstName

string · minLength: 2 · maxLength: 256 · required

lastName

string · minLength: 2 · maxLength: 256 · required

role

string · enum · required

The role of the user. Admins have access to the Aforza Admin Portal (https://admin.aforza.com)

Enum values:

USER

ADMIN

backendApplications

string[] · minItems: 0 · unique · required

A list of applications the user has access to. DAM = Aforza Studio, LLM = Ava

Enum values:

DAM

LLM

salesforceUserId

string · minLength: 18 · maxLength: 18

The Salesforce user ID of the user. Must be 18 characters long.

language

string · enum

Enum values:

en-GB

country

string · enum

Enum values:

Afghanistan

Albania

Algeria

Andorra

Angola

Antigua and Barbuda

Argentina

Armenia

locale

string · enum

Enum values:

ar-AE

ar-BH

ar-DJ

ar-DZ

ar-EG

ar-EH

ar-ER

timeZone

string · enum

Enum values:

Africa/Abidjan

Africa/Accra

Africa/Addis_Ababa

Africa/Algiers

Africa/Asmera

Africa/Bamako

Africa/Bangui

Africa/Banjul

object

Required if the user has access to Aforza Studio (backendApplications includes DAM)

Example: {"role":"USER","defaultSpaceRole":"VIEWER"}

object

Required if the user has access to Ava (backendApplications includes LLM)

Example: {"role":"USER"}

UserResponse

userId

string · readOnly · required

firstName

string · readOnly · required

lastName

string · readOnly · required

displayName

string · readOnly · required

emailAddress

string · readOnly · required

status

string · enum · readOnly · required

Enum values:

PROVISIONED

ACTIVE

INACTIVE

DELETED

role

string · enum · readOnly · required

Enum values:

USER

ADMIN

createdDate

string · date-time · readOnly · required

oktaUserId

string · readOnly · required

object · readOnly · required

avatarUrl

string · readOnly

language

string · enum · readOnly

Enum values:

en-GB

country

string · enum · readOnly

Enum values:

Afghanistan

Albania

Algeria

Andorra

Angola

Antigua and Barbuda

Argentina

Armenia

locale

string · enum · readOnly

Enum values:

ar-AE

ar-BH

ar-DJ

ar-DZ

ar-EG

ar-EH

ar-ER

timeZone

string · enum · readOnly

Enum values:

Africa/Abidjan

Africa/Accra

Africa/Addis_Ababa

Africa/Algiers

Africa/Asmera

Africa/Bamako

Africa/Bangui

Africa/Banjul

salesforceUserId

string · readOnly

object · readOnly

ErrorResponse

statusCode

number · readOnly · required

error

string · readOnly · required

message

string · readOnly · required

errorCode

string · enum · readOnly

Enum values:

AVA_NOT_ENABLED

EMAIL_CONFLICT

NO_AVAILABLE_LICENCES

SALESFORCE_USER_ID_CONFLICT

STUDIO_NOT_ENABLED

STUDIO_SPACE_INFO_REQUIRED

THIRD_PARTY_EMAIL_CONFLICT

AVA_CONFIG_MISSING_REQUIRED_PROPERTIES

field

string · enum · readOnly

Enum values:

displayName

emailAddress

firstName

lastName

oktaUserId

salesforceUserId

status

role

UserUpdateRequest

emailAddress

string · minLength: 2 · maxLength: 256

firstName

string · minLength: 2 · maxLength: 256

lastName

string · minLength: 2 · maxLength: 256

role

string · enum

Enum values:

USER

ADMIN

salesforceUserId

null | string · minLength: 18 · maxLength: 18

language

string · enum

Enum values:

en-GB

country

string · enum

Enum values:

Afghanistan

Albania

Algeria

Andorra

Angola

Antigua and Barbuda

Argentina

Armenia

locale

string · enum

Enum values:

ar-AE

ar-BH

ar-DJ

ar-DZ

ar-EG

ar-EH

ar-ER

timeZone

string · enum

Enum values:

Africa/Abidjan

Africa/Accra

Africa/Addis_Ababa

Africa/Algiers

Africa/Asmera

Africa/Bamako

Africa/Bangui

Africa/Banjul

backendApplications

string[] · minItems: 1 · unique

Enum values:

DAM

LLM

object