create_group_v2_groups_post
create_group_v2_groups_post: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": {
description?: string
| null;
name: string;
parent_id?: string | null;
policies?: {
authentication_assurance_timeout?: number | null;
group_members_visibility?: "members" | "managers" | null;
group_visibility?: "authenticated" | "private" | null;
is_high_assurance?: boolean | null;
join_requests?: boolean | null;
signup_fields?:
| (
| "state"
| "department"
| "institution"
| "current_project_name"
| "address"
| "city"
| "country"
| "address1"
| "address2"
| "zip"
| "phone"
| "field_of_science"
)[]
| null;
};
terms_and_conditions?: string
| null;
};
};
};
responses: {
"201": {
content: {
"application/json": {
allowed_actions?: | {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
}
| null;
child_ids?: string[]
| null;
description?: string | null;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
my_memberships?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
name: string;
parent_id: string
| null;
policies?: {
authentication_assurance_timeout?: number | null;
group_members_visibility: "members" | "managers";
group_visibility: "authenticated" | "private";
is_high_assurance: boolean;
join_requests?: boolean;
signup_fields: (
| "state"
| "department"
| "institution"
| "current_project_name"
| "address"
| "city"
| "country"
| "address1"
| "address2"
| "zip"
| "phone"
| "field_of_science"
)[];
};
session_limit?: number
| null;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: string
| null;
subscription_id?: string | null;
subscription_info?:
| {
connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
}
| null;
terms_and_conditions?: string
| null;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
ambiguous_identities: string[];
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
delete_group_v2_groups__group_id__delete
delete_group_v2_groups__group_id__delete: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { group_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
allowed_actions?: | {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
}
| null;
child_ids?: string[]
| null;
description?: string | null;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
my_memberships?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
name: string;
parent_id: string
| null;
policies?: {
authentication_assurance_timeout?: number | null;
group_members_visibility: "members" | "managers";
group_visibility: "authenticated" | "private";
is_high_assurance: boolean;
join_requests?: boolean;
signup_fields: (
| "state"
| "department"
| "institution"
| "current_project_name"
| "address"
| "city"
| "country"
| "address1"
| "address2"
| "zip"
| "phone"
| "field_of_science"
)[];
};
session_limit?: number
| null;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: string
| null;
subscription_id?: string | null;
subscription_info?:
| {
connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
}
| null;
terms_and_conditions?: string
| null;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
ambiguous_identities: string[];
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
get_children_v2_groups__group_id__children_get
get_children_v2_groups__group_id__children_get: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { group_id: string };
query?: { include?: string[] | null };
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
children: {
allowed_actions?: | {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
}
| null;
child_ids?: string[]
| null;
description?: string | null;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| {
group_id: string;
identity_id: string;
invite_email_address?: (...)
| (...)
| (...);
invite_time?: (...) | (...) | (...);
membership_fields: (...) | (...);
role: (...) | (...) | (...);
source_group_id?: (...) | (...);
status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
status_reason?: (...) | (...) | (...);
updated?: (...) | (...) | (...);
username: string;
}[]
| null;
my_memberships?: | {
group_id: string;
identity_id: string;
invite_email_address?: (...)
| (...)
| (...);
invite_time?: (...) | (...) | (...);
membership_fields: (...) | (...);
role: (...) | (...) | (...);
source_group_id?: (...) | (...);
status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
status_reason?: (...) | (...) | (...);
updated?: (...) | (...) | (...);
username: string;
}[]
| null;
name: string;
parent_id: string
| null;
policies?: {
authentication_assurance_timeout?: number | null;
group_members_visibility: "members" | "managers";
group_visibility: "authenticated" | "private";
is_high_assurance: boolean;
join_requests?: boolean;
signup_fields: (
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
)[];
};
session_limit?: number
| null;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: string
| null;
subscription_id?: string | null;
subscription_info?:
| {
connectors: { [key: string]: { is_baa: ...; is_ha: ... } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
}
| null;
terms_and_conditions?: string
| null;
}[];
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
get_group_by_subscription_id_v2_subscription_info__subscription_id__get
get_group_by_subscription_id_v2_subscription_info__subscription_id__get: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { subscription_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
group_id: string;
subscription_id: string;
subscription_info: {
connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
is_baa: boolean;
is_high_assurance: boolean;
};
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
get_group_v2_groups__group_id__get
get_group_v2_groups__group_id__get: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { group_id: string };
query?: { include?: string[] | null };
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
allowed_actions?: | {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
}
| null;
child_ids?: string[]
| null;
description?: string | null;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
my_memberships?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
name: string;
parent_id: string
| null;
policies?: {
authentication_assurance_timeout?: number | null;
group_members_visibility: "members" | "managers";
group_visibility: "authenticated" | "private";
is_high_assurance: boolean;
join_requests?: boolean;
signup_fields: (
| "state"
| "department"
| "institution"
| "current_project_name"
| "address"
| "city"
| "country"
| "address1"
| "address2"
| "zip"
| "phone"
| "field_of_science"
)[];
};
session_limit?: number
| null;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: string
| null;
subscription_id?: string | null;
subscription_info?:
| {
connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
}
| null;
terms_and_conditions?: string
| null;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
get_identity_set_preferences_v2_preferences_get
get_identity_set_preferences_v2_preferences_get: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": { [key: string]: { allow_add: boolean
| null } };
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
get_membership_fields_v2_groups__group_id__membership_fields_get
get_membership_fields_v2_groups__group_id__membership_fields_get: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { group_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
[key: string]: {
address?: string
| null;
address1?: string | null;
address2?: string | null;
city?: string | null;
country?: string | null;
current_project_name?: string | null;
department?: string | null;
field_of_science?: string | null;
first_name?: string | null;
institution?: string | null;
last_name?: string | null;
organization?: string | null;
phone?: string | null;
state?: string | null;
zip?: string | null;
};
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
get_my_groups_and_memberships_v2_groups_my_groups_get
get_my_groups_and_memberships_v2_groups_my_groups_get: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: { statuses?: string[] };
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
allowed_actions?: | {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
}
| null;
child_ids?: string[]
| null;
description?: string | null;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: ...]: ... } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
my_memberships?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: ...]: ... } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
name: string;
parent_id: string
| null;
policies?: {
authentication_assurance_timeout?: number | null;
group_members_visibility: "members" | "managers";
group_visibility: "authenticated" | "private";
is_high_assurance: boolean;
join_requests?: boolean;
signup_fields: (
| "state"
| "department"
| "institution"
| "current_project_name"
| "address"
| "city"
| "country"
| "address1"
| "address2"
| "zip"
| "phone"
| "field_of_science"
)[];
};
session_limit?: number
| null;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: string
| null;
subscription_id?: string | null;
subscription_info?:
| {
connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
}
| null;
terms_and_conditions?: string
| null;
}[];
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
get_policies_v2_groups__group_id__policies_get
get_policies_v2_groups__group_id__policies_get: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { group_id: string };
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
authentication_assurance_timeout?: number
| null;
group_members_visibility: "members" | "managers";
group_visibility: "authenticated" | "private";
is_high_assurance: boolean;
join_requests?: boolean;
signup_fields: (
| "state"
| "department"
| "institution"
| "current_project_name"
| "address"
| "city"
| "country"
| "address1"
| "address2"
| "zip"
| "phone"
| "field_of_science"
)[];
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
get_statuses_v2_groups_statuses_get
get_statuses_v2_groups_statuses_get: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
[key: string]: {
active: number;
declined: number;
invited: number;
left: number;
pending: number;
rejected: number;
removed: number;
};
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
group_membership_post_actions_v2_groups__group_id__post
group_membership_post_actions_v2_groups__group_id__post: {
parameters: {
cookie?: undefined;
header?: { "community-context"?: string | null };
path: { group_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": {
accept?: | { identity_id: string; status_reason?: string
| null }[]
| null;
add?:
| {
identity_id: string;
role: "manager"
| "admin"
| "member"
| null;
status_reason?: string | null;
}[]
| null;
approve?: | { identity_id: string; status_reason?: string
| null }[]
| null;
change_role?:
| {
identity_id: string;
role: "manager"
| "admin"
| "member"
| null;
}[]
| null;
decline?: | { identity_id: string; status_reason?: string
| null }[]
| null;
invite?:
| {
identity_id: string;
invite_email_address?: string
| null;
role: "manager" | "admin" | "member" | null;
status_reason?: string | null;
}[]
| null;
join?: { identity_id: string }[]
| null;
leave?: { identity_id: string; status_reason?: string | null }[] | null;
reject?: { identity_id: string; status_reason?: string | null }[] | null;
remove?: { identity_id: string; status_reason?: string | null }[] | null;
request_join?: { identity_id: string }[] | null;
};
};
};
responses: {
"200": {
content: {
"application/json": {
accept?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
add?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
approve?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
change_role?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
decline?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
errors?: | {
accept?: | { code: string; detail: string; identity_id: string }[]
| null;
add?: { code: string; detail: string; identity_id: string }[] | null;
approve?:
| { code: string; detail: string; identity_id: string }[]
| null;
change_role?:
| { code: string; detail: string; identity_id: string }[]
| null;
decline?:
| { code: string; detail: string; identity_id: string }[]
| null;
invite?:
| { code: string; detail: string; identity_id: string }[]
| null;
join?: { code: string; detail: string; identity_id: string }[] | null;
leave?: { code: string; detail: string; identity_id: string }[] | null;
reject?:
| { code: string; detail: string; identity_id: string }[]
| null;
remove?:
| { code: string; detail: string; identity_id: string }[]
| null;
request_join?:
| { code: string; detail: string; identity_id: string }[]
| null;
}
| null;
invite?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
join?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
leave?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
reject?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
remove?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
request_join?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
};
};
headers: { [name: string]: unknown };
};
"400": {
content: {
"application/json": {
ambiguous_identities: string[];
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"409": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
put_identity_set_preferences_v2_preferences_put
put_identity_set_preferences_v2_preferences_put: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": { [key: string]: { allow_add: boolean
| null } };
};
};
responses: {
"200": {
content: {
"application/json": { [key: string]: { allow_add: boolean
| null } };
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
put_membership_fields_v2_groups__group_id__membership_fields_put
put_membership_fields_v2_groups__group_id__membership_fields_put: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { group_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": {
[key: string]: {
address?: string
| null;
address1?: string | null;
address2?: string | null;
city?: string | null;
country?: string | null;
current_project_name?: string | null;
department?: string | null;
field_of_science?: string | null;
first_name?: string | null;
institution?: string | null;
last_name?: string | null;
organization?: string | null;
phone?: string | null;
state?: string | null;
zip?: string | null;
};
};
};
};
responses: {
"200": {
content: {
"application/json": {
[key: string]: {
address?: string
| null;
address1?: string | null;
address2?: string | null;
city?: string | null;
country?: string | null;
current_project_name?: string | null;
department?: string | null;
field_of_science?: string | null;
first_name?: string | null;
institution?: string | null;
last_name?: string | null;
organization?: string | null;
phone?: string | null;
state?: string | null;
zip?: string | null;
};
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
update_group_v2_groups__group_id__put
update_group_v2_groups__group_id__put: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { group_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": {
description?: string
| null;
name?: string | null;
subscription_admin_verified_id?: string | null;
terms_and_conditions?: string | null;
};
};
};
responses: {
"200": {
content: {
"application/json": {
allowed_actions?: | {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
}
| null;
child_ids?: string[]
| null;
description?: string | null;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
my_memberships?: | {
group_id: string;
identity_id: string;
invite_email_address?: string
| null;
invite_time?: string | null;
membership_fields: { [key: string]: unknown } | null;
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: string
| null;
updated?: string | null;
username: string;
}[]
| null;
name: string;
parent_id: string
| null;
policies?: {
authentication_assurance_timeout?: number | null;
group_members_visibility: "members" | "managers";
group_visibility: "authenticated" | "private";
is_high_assurance: boolean;
join_requests?: boolean;
signup_fields: (
| "state"
| "department"
| "institution"
| "current_project_name"
| "address"
| "city"
| "country"
| "address1"
| "address2"
| "zip"
| "phone"
| "field_of_science"
)[];
};
session_limit?: number
| null;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: string
| null;
subscription_id?: string | null;
subscription_info?:
| {
connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
}
| null;
terms_and_conditions?: string
| null;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
update_policies_v2_groups__group_id__policies_put
update_policies_v2_groups__group_id__policies_put: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { group_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": {
authentication_assurance_timeout?: number
| null;
group_members_visibility?: "members" | "managers" | null;
group_visibility?: "authenticated" | "private" | null;
is_high_assurance?: boolean | null;
join_requests?: boolean | null;
signup_fields?:
| (
| "state"
| "department"
| "institution"
| "current_project_name"
| "address"
| "city"
| "country"
| "address1"
| "address2"
| "zip"
| "phone"
| "field_of_science"
)[]
| null;
};
};
};
responses: {
"200": {
content: {
"application/json": {
authentication_assurance_timeout?: number
| null;
group_members_visibility: "members" | "managers";
group_visibility: "authenticated" | "private";
is_high_assurance: boolean;
join_requests?: boolean;
signup_fields: (
| "state"
| "department"
| "institution"
| "current_project_name"
| "address"
| "city"
| "country"
| "address1"
| "address2"
| "zip"
| "phone"
| "field_of_science"
)[];
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}
update_subscription_admin_verified_id_v2_groups__group_id__subscription_admin_verified_put
update_subscription_admin_verified_id_v2_groups__group_id__subscription_admin_verified_put: {
parameters: {
cookie?: undefined;
header?: undefined;
path: { group_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": { subscription_admin_verified_id: string
| null };
};
};
responses: {
"200": {
content: {
"application/json": {
group_id: string;
subscription_admin_verified_id: string
| null;
};
};
headers: { [name: string]: unknown };
};
"401": {
content: {
"application/json": {
authorization_parameters: {
extra?: { [key: string]: unknown };
required_scopes?: string[];
session_message?: string;
session_required_identities?: string[];
session_required_mfa?: boolean;
session_required_policies?: string[];
session_required_single_domain?: string[];
};
code: string;
detail: string;
};
};
headers: { [name: string]: unknown };
};
"403": {
content: {
"application/json": {
code: string;
detail: string;
provided_scopes?: string[]
| null;
};
};
headers: { [name: string]: unknown };
};
"404": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: (string | number)[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
"500": {
content: { "application/json": { code: string; detail: string } };
headers: { [name: string]: unknown };
};
};
}