Interface OrgMemberRead

Export

OrgMemberRead

Hierarchy

  • OrgMemberRead

Properties

created_at email email_verified family_name? given_name? id identities invite? is_onboarding is_superuser last_ip? last_login? logins_count? name? onboarding_step picture? settings

Properties

created_at

created_at: string

Date and time when the account member was created (ISO_8601 format).

Memberof

OrgMemberRead

email

email: string

Email of the user controlling this account

Memberof

OrgMemberRead

email_verified

email_verified: boolean

Whether this email address is verified or not. For social providers like 'Login with Google' this is done automatically, otherwise we will send the user a verification link in email.

Memberof

OrgMemberRead

Optional family_name

family_name?: string

Last name of the user

Memberof

OrgMemberRead

Optional given_name

given_name?: string

First name of the user

Memberof

OrgMemberRead

id

id: string

Unique id of the account member

Memberof

OrgMemberRead

identities

identities: IdentityRead[]

Memberof

OrgMemberRead

Optional invite

invite?: InviteRead

Memberof

OrgMemberRead

is_onboarding

is_onboarding: boolean

Whether or not this user is currently onboarding, needs to be replaced by a user journey object

Memberof

OrgMemberRead

is_superuser

is_superuser: boolean

Whether or not this user has special access to permit.io organizations

Memberof

OrgMemberRead

Optional last_ip

last_ip?: string

Last IP address from which this user logged in.

Memberof

OrgMemberRead

Optional last_login

last_login?: string

Last date and time this user logged in (ISO_8601 format).

Memberof

OrgMemberRead

Optional logins_count

logins_count?: number

Total number of logins this user has performed.

Memberof

OrgMemberRead

Optional name

name?: string

Name of this user

Memberof

OrgMemberRead

onboarding_step

onboarding_step: OnboardingStep

the step the user is currently going through in onboarding

Memberof

OrgMemberRead

Optional picture

picture?: string

URL to picture, photo, or avatar of the user that controls this account.

Memberof

OrgMemberRead

settings

settings: object

Custom permit.io dashboard settings, such as preferred theme, etc.

Memberof

OrgMemberRead

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc