@manta-eu/lib/custom-app

Type Aliases

CustomAppUserField

CustomAppUserField = object

Properties

agent?

optional agent?: boolean

value

value: CustomAppUserFieldValue

---

CustomAppUserFieldValue

CustomAppUserFieldValue = string | number | boolean

---

CustomAppUserProfile

CustomAppUserProfile = object

Properties

email?

optional email?: string

fields?

optional fields?: Record<string, CustomAppUserField>

name?

optional name?: string

---

CustomAppUserTokenRequest

CustomAppUserTokenRequest = CustomAppUserProfile & object

Type Declaration

anonymous_id?

optional anonymous_id?: string

client_id

client_id: string

client_secret

client_secret: string

datastores?

optional datastores?: string[]

teams?

optional teams?: string[]

user_id?

optional user_id?: string

---

CustomAppUserTokenResponse

CustomAppUserTokenResponse = object

Properties

access_token

access_token: string

expires_in

expires_in: number

token_type

token_type: "Bearer"

Variables

anonymousVisitorIdName

const anonymousVisitorIdName: "An anonymous visitor id" = "An anonymous visitor id"

---

customAppClientIdPattern

const customAppClientIdPattern: RegExp

---

customAppClientIdPrefix

const customAppClientIdPrefix: "ext-" = "ext-"

---

customAppUserFieldKeyPattern

const customAppUserFieldKeyPattern: RegExp

---

customAppUserIdPattern

const customAppUserIdPattern: RegExp

---

customAppUsersIdpAlias

const customAppUsersIdpAlias: "manta-custom-app-users" = "manta-custom-app-users"

---

customAppUsersPath

const customAppUsersPath: "/agents/custom-app-users" = "/agents/custom-app-users"

---

customAppUserTokenPath

const customAppUserTokenPath: "/agents/custom-app-users/token"

---

maxCustomAppClientIdLength

const maxCustomAppClientIdLength: 64 = 64

---

maxCustomAppUserAgentFieldsLength

const maxCustomAppUserAgentFieldsLength: 4096 = 4096

---

maxCustomAppUserDatastores

const maxCustomAppUserDatastores: 50 = 50

---

maxCustomAppUserEmailLength

const maxCustomAppUserEmailLength: 320 = 320

---

maxCustomAppUserFieldLength

const maxCustomAppUserFieldLength: 1024 = 1024

---

maxCustomAppUserFields

const maxCustomAppUserFields: 50 = 50

---

maxCustomAppUserNameLength

const maxCustomAppUserNameLength: 200 = 200

---

maxCustomAppUserTeams

const maxCustomAppUserTeams: 50 = 50

Functions

anonymousPrincipalId()

anonymousPrincipalId(clientId, anonymousId): string

Parameters

clientId

string

anonymousId

string

Returns

string

---

anonymousSubject()

anonymousSubject(clientId): string

Parameters

clientId

string

Returns

string

---

customAppClientIdOfUsername()

customAppClientIdOfUsername(username): string | undefined

Parameters

username

string | undefined

Returns

string | undefined

---

customAppClientIdProblem()

customAppClientIdProblem(clientId): string | undefined

Parameters

clientId

unknown

Returns

string | undefined

---

customAppUserDatastoresProblem()

customAppUserDatastoresProblem(datastores): string | undefined

Parameters

datastores

unknown

Returns

string | undefined

---

customAppUserIdOfSubject()

customAppUserIdOfSubject(clientId, subject): string | undefined

Parameters

clientId

string

subject

string | undefined

Returns

string | undefined

---

customAppUserIdProblem()

customAppUserIdProblem(userId, name?): string | undefined

Parameters

userId

unknown

name?

string = "A custom app user id"

Returns

string | undefined

---

customAppUsernamePrefix()

customAppUsernamePrefix(clientId): string

Parameters

clientId

string

Returns

string

---

customAppUserProfileProblem()

customAppUserProfileProblem(profile): string | undefined

Parameters

profile

CustomAppUserProfile

Returns

string | undefined

---

customAppUserSubject()

customAppUserSubject(clientId, userId): string

Parameters

clientId

string

userId

string

Returns

string

---

customAppUserTeamsProblem()

customAppUserTeamsProblem(teams): string | undefined

Parameters

teams

unknown

Returns

string | undefined

---

redirectUrlProblem()

redirectUrlProblem(raw): string | undefined

Parameters

raw

string

Returns

string | undefined