Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 1.26 KB

File metadata and controls

19 lines (15 loc) · 1.26 KB

User

User

Properties

Name Type Required Description
id UserId Yes
username UserUsername Yes The Foundry username of the User. This is unique within the realm.
given_name Optional[str] No The given name of the User.
family_name Optional[str] No The family name (last name) of the User.
email Optional[str] No The email at which to contact a User. Multiple users may have the same email address.
realm Realm Yes
organization Optional[OrganizationRid] No The RID of the user's primary Organization. This will be blank for third-party application service users.
status UserStatus Yes The current status of the user.
attributes Dict[AttributeName, AttributeValues] Yes A map of the User's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. Additional attributes may be configured by Foundry administrators in Control Panel and populated by the User's SSO provider upon login.

[Back to Model list] [Back to API list] [Back to README]