Accept
Add
Approve
Change Role
Decline
Invite
Join
Leave
Reject
Remove
Request Join
AuthErrorModel
Optional
extra?: { [key: string]: unknown }Extra
Optional
required_scopes?: string[]Required Scopes
Optional
session_message?: stringSession Message
Optional
session_required_identities?: string[]Session Required Identities
Optional
session_required_mfa?: booleanSession Required Mfa
Optional
session_required_policies?: string[]Session Required Policies
Optional
session_required_single_domain?: string[]Session Required Single Domain
Code
Detail
AuthParamsModel
Optional
extra?: { [key: string]: unknown }Extra
Optional
required_scopes?: string[]Required Scopes
Optional
session_message?: stringSession Message
Optional
session_required_identities?: string[]Session Required Identities
Optional
session_required_mfa?: booleanSession Required Mfa
Optional
session_required_policies?: string[]Session Required Policies
Optional
session_required_single_domain?: string[]Session Required Single Domain
BadRequestErrorModel
Ambiguous Identities
Code
Detail
BaseErrorModel
Code
Detail
ConnectorSubscriptionInfo
Is Baa
Is Ha
ForbiddenErrorModel
Code
Detail
Optional
provided_scopes?: null | string[]Provided Scopes
GroupChildrenReadModel
Children
GroupCreateModel
Optional
description?: null | stringDescription
Name
Optional
parent_id?: null | stringParent Id
Optional
policies?: {Optional
authentication_assurance_timeout?: null | numberAuthentication Assurance Timeout
Optional
group_members_visibility?: null | "members" | "managers"Optional
group_visibility?: null | "authenticated" | "private"Optional
is_high_assurance?: null | booleanIs High Assurance
Optional
join_requests?: null | booleanJoin Requests
Optional
signup_fields?: Signup Fields
Optional
terms_and_conditions?: null | stringTerms And Conditions
GroupMembershipPostAction
Optional
accept?: null | { identity_id: string; status_reason?: null | string }[]Accept
Optional
add?: Add
Optional
approve?: null | { identity_id: string; status_reason?: null | string }[]Approve
Optional
change_role?: null | { identity_id: string; role: null | "manager" | "admin" | "member" }[]Change Role
Optional
decline?: null | { identity_id: string; status_reason?: null | string }[]Decline
Optional
invite?: Invite
Optional
join?: null | { identity_id: string }[]Join
Optional
leave?: null | { identity_id: string; status_reason?: null | string }[]Leave
Optional
reject?: null | { identity_id: string; status_reason?: null | string }[]Reject
Optional
remove?: null | { identity_id: string; status_reason?: null | string }[]Remove
Optional
request_join?: null | { identity_id: string }[]Request Join
GroupMembershipPostActionErrors
Optional
accept?: null | { code: string; detail: string; identity_id: string }[]Accept
Optional
add?: null | { code: string; detail: string; identity_id: string }[]Add
Optional
approve?: null | { code: string; detail: string; identity_id: string }[]Approve
Optional
change_role?: null | { code: string; detail: string; identity_id: string }[]Change Role
Optional
decline?: null | { code: string; detail: string; identity_id: string }[]Decline
Optional
invite?: null | { code: string; detail: string; identity_id: string }[]Invite
Optional
join?: null | { code: string; detail: string; identity_id: string }[]Join
Optional
leave?: null | { code: string; detail: string; identity_id: string }[]Leave
Optional
reject?: null | { code: string; detail: string; identity_id: string }[]Reject
Optional
remove?: null | { code: string; detail: string; identity_id: string }[]Remove
Optional
request_join?: null | { code: string; detail: string; identity_id: string }[]Request Join
GroupMembershipPostActionResponse
Optional
accept?: Accept
Optional
add?: Add
Optional
approve?: Approve
Optional
change_role?: Change Role
Optional
decline?: Decline
Optional
errors?: Optional
invite?: Invite
Optional
join?: Join
Optional
leave?: Leave
Optional
reject?: Reject
Optional
remove?: Remove
Optional
request_join?: Request Join
GroupMemberVisibilityPolicyEnum
GroupPolicyReadModel
Optional
authentication_assurance_timeout?: null | numberAuthentication Assurance Timeout
Is High Assurance
Optional
join_requests?: booleanJoin Requests
Signup Fields
GroupPolicyWriteModel
Optional
authentication_assurance_timeout?: null | numberAuthentication Assurance Timeout
Optional
group_members_visibility?: null | "members" | "managers"Optional
group_visibility?: null | "authenticated" | "private"Optional
is_high_assurance?: null | booleanIs High Assurance
Optional
join_requests?: null | booleanJoin Requests
Optional
signup_fields?: Signup Fields
GroupReadModel
Optional
allowed_actions?: Optional
child_ids?: null | string[]Child Ids
Optional
description?: null | stringDescription
Enforce Session
Id Format: uuid
Optional
memberships?: Memberships
Optional
my_memberships?: My Memberships
Name
Parent Id
Optional
policies?: {Optional
authentication_assurance_timeout?: null | numberAuthentication Assurance Timeout
Is High Assurance
Optional
join_requests?: booleanJoin Requests
Signup Fields
Optional
session_limit?: null | numberSession Limit
Session Timeouts
Optional
subscription_admin_verified_id?: null | stringSubscription Admin Verified Id
Optional
subscription_id?: null | stringSubscription Id
Optional
subscription_info?: Optional
terms_and_conditions?: null | stringTerms And Conditions
GroupStatusCounts
Active
Declined
Invited
Left
Pending
Rejected
Removed
GroupSubscriptionModel
Group Id Format: uuid
Subscription Id Format: uuid
Connectors
Is Baa
Is High Assurance
GroupTypeEnum
GroupVisibilityPolicyEnum
GroupWriteModel
Optional
description?: null | stringDescription
Optional
name?: null | stringName
Optional
subscription_admin_verified_id?: null | stringSubscription Admin Verified Id
Optional
terms_and_conditions?: null | stringTerms And Conditions
HTTPValidationError
Optional
detail?: { loc: (string | number)[]; msg: string; type: string }[]Detail
IdentityPreferences
Allow Add
MembershipActionBaseModel
Identity Id Format: uuid
MembershipActionInviteModel
Identity Id Format: uuid
Optional
invite_email_address?: null | stringInvite Email Address
Optional
status_reason?: null | stringStatus Reason
MembershipActionStatusAndRoleModel
Identity Id Format: uuid
Optional
status_reason?: null | stringStatus Reason
MembershipActionStatusModel
Identity Id Format: uuid
Optional
status_reason?: null | stringStatus Reason
MembershipError
Code
Detail
Identity Id
MembershipFields
Optional
address?: null | stringAddress
Optional
address1?: null | stringAddress1
Optional
address2?: null | stringAddress2
Optional
city?: null | stringCity
Optional
country?: null | stringCountry
Optional
current_project_name?: null | stringCurrent Project Name
Optional
department?: null | stringDepartment
Optional
field_of_science?: null | stringField Of Science
Optional
first_name?: null | stringFirst Name
Optional
institution?: null | stringInstitution
Optional
last_name?: null | stringLast Name
Optional
organization?: null | stringOrganization
Optional
phone?: null | stringPhone
Optional
state?: null | stringState
Optional
zip?: null | stringZip
MembershipReadModel
Group Id Format: uuid
Identity Id Format: uuid
Optional
invite_email_address?: null | stringInvite Email Address
Optional
invite_time?: null | stringInvite Time
Membership Fields
Optional
source_group_id?: stringSource Group Id Format: uuid
Optional
status_reason?: null | stringStatus Reason
Optional
updated?: null | stringUpdated
Username
MembershipsActionChangeRoleModel
Identity Id Format: uuid
RoleEnum
SignupFieldsEnum
StatusEnum
SubscriptionModel
Connectors
Is Baa
Is High Assurance
Name
Subscriber Name
SubscriptionModelLimited
Connectors
Is Baa
Is High Assurance
SubscriptionVerifiedReadModel
Group Id Format: uuid
Subscription Admin Verified Id
SubscriptionVerifiedWriteModel
Subscription Admin Verified Id
TimeoutData
Expire Time Format: date-time
Expires In
ValidationError
Location
Message
Error Type
AllowedActionsModel