Skip to main content

Interface: PersonRet

Types.PersonRet

Abridged person structure

Export

Interface

PersonRet

Properties​

active​

• active: boolean

A flag indicating whether the person is active or not

Memberof

PersonRet

attributes​

• Optional attributes: Object

Attributes divided into named buckets. Bucket names are top level keys; attributes are values. Attributes consist of key-value pairs. Attribute names (keys) may be at most 70 bytes long. Attribute values must be JSON-serializable.

Memberof

PersonRet

Index signature​

▪ [key: string]: { [key: string]: any; }

groups​

• Optional groups: string[]

Memberof

PersonRet

handles​

• Optional handles: PersonHandle[]

Memberof

PersonRet

person_id​

• person_id: string

The ID of the person

Memberof

PersonRet

region​

• region: string

Memberof

PersonRet

roles​

• Optional roles: string[]

A custom list of roles for the person

Memberof

PersonRet