create_group_v2_groups_post
create_group_v2_groups_post: {
parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: undefined;
};
requestBody: {
content: {
"application/json": {
description?: null
| string;
name: string;
parent_id?: null | string;
policies?: {
authentication_assurance_timeout?: null | number;
group_members_visibility?: null | "members" | "managers";
group_visibility?: null | "authenticated" | "private";
is_high_assurance?: null | boolean;
join_requests?: null | boolean;
signup_fields?:
| null
| (
| "state"
| "department"
| "institution"
| "current_project_name"
| "address"
| "city"
| "country"
| "address1"
| "address2"
| "zip"
| "phone"
| "field_of_science"
)[];
};
terms_and_conditions?: null
| string;
};
};
};
responses: {
"201": {
content: {
"application/json": {
allowed_actions?: | null
| {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
};
child_ids?: null
| string[];
description?: null | string;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
my_memberships?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
name: string;
parent_id: null
| string;
policies?: {
authentication_assurance_timeout?: null | number;
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?: null
| number;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: null
| string;
subscription_id?: null | string;
subscription_info?:
| null
| {
connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
};
terms_and_conditions?: null
| string;
};
};
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?: null
| string[];
};
};
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?: | null
| {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
};
child_ids?: null
| string[];
description?: null | string;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
my_memberships?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
name: string;
parent_id: null
| string;
policies?: {
authentication_assurance_timeout?: null | number;
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?: null
| number;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: null
| string;
subscription_id?: null | string;
subscription_info?:
| null
| {
connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
};
terms_and_conditions?: null
| string;
};
};
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?: null
| string[];
};
};
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?: null | string[] };
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
children: {
allowed_actions?: | null
| {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
};
child_ids?: null
| string[];
description?: null | string;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| null
| {
group_id: string;
identity_id: string;
invite_email_address?: (...)
| (...)
| (...);
invite_time?: (...) | (...) | (...);
membership_fields: (...) | (...);
role: (...) | (...) | (...);
source_group_id?: (...) | (...);
status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
status_reason?: (...) | (...) | (...);
updated?: (...) | (...) | (...);
username: string;
}[];
my_memberships?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: (...)
| (...)
| (...);
invite_time?: (...) | (...) | (...);
membership_fields: (...) | (...);
role: (...) | (...) | (...);
source_group_id?: (...) | (...);
status: (...) | (...) | (...) | (...) | (...) | (...) | (...);
status_reason?: (...) | (...) | (...);
updated?: (...) | (...) | (...);
username: string;
}[];
name: string;
parent_id: null
| string;
policies?: {
authentication_assurance_timeout?: null | number;
group_members_visibility: "members" | "managers";
group_visibility: "authenticated" | "private";
is_high_assurance: boolean;
join_requests?: boolean;
signup_fields: (
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
| (...)
)[];
};
session_limit?: null
| number;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: null
| string;
subscription_id?: null | string;
subscription_info?:
| null
| {
connectors: { [key: string]: { is_baa: ...; is_ha: ... } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
};
terms_and_conditions?: null
| 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?: null
| string[];
};
};
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?: null
| string[];
};
};
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?: null | string[] };
};
requestBody?: undefined;
responses: {
"200": {
content: {
"application/json": {
allowed_actions?: | null
| {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
};
child_ids?: null
| string[];
description?: null | string;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
my_memberships?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
name: string;
parent_id: null
| string;
policies?: {
authentication_assurance_timeout?: null | number;
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?: null
| number;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: null
| string;
subscription_id?: null | string;
subscription_info?:
| null
| {
connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
};
terms_and_conditions?: null
| 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?: null
| string[];
};
};
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: null
| 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?: null
| string[];
};
};
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?: null
| string;
address1?: null | string;
address2?: null | string;
city?: null | string;
country?: null | string;
current_project_name?: null | string;
department?: null | string;
field_of_science?: null | string;
first_name?: null | string;
institution?: null | string;
last_name?: null | string;
organization?: null | string;
phone?: null | string;
state?: null | string;
zip?: null | 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?: null
| string[];
};
};
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?: | null
| {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
};
child_ids?: null
| string[];
description?: null | string;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: ...]: ... };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
my_memberships?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: ...]: ... };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
name: string;
parent_id: null
| string;
policies?: {
authentication_assurance_timeout?: null | number;
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?: null
| number;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: null
| string;
subscription_id?: null | string;
subscription_info?:
| null
| {
connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
};
terms_and_conditions?: null
| 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?: null
| string[];
};
};
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?: null
| number;
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?: null
| string[];
};
};
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?: null
| string[];
};
};
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"?: null | string };
path: { group_id: string };
query?: undefined;
};
requestBody: {
content: {
"application/json": {
accept?: | null
| { identity_id: string; status_reason?: null
| string }[];
add?:
| null
| {
identity_id: string;
role: null
| "manager"
| "admin"
| "member";
status_reason?: null | string;
}[];
approve?: | null
| { identity_id: string; status_reason?: null
| string }[];
change_role?:
| null
| { identity_id: string; role: null
| "manager"
| "admin"
| "member" }[];
decline?:
| null
| { identity_id: string; status_reason?: null
| string }[];
invite?:
| null
| {
identity_id: string;
invite_email_address?: null
| string;
role: null | "manager" | "admin" | "member";
status_reason?: null | string;
}[];
join?: null
| { identity_id: string }[];
leave?: null | { identity_id: string; status_reason?: null | string }[];
reject?: null | { identity_id: string; status_reason?: null | string }[];
remove?: null | { identity_id: string; status_reason?: null | string }[];
request_join?: null | { identity_id: string }[];
};
};
};
responses: {
"200": {
content: {
"application/json": {
accept?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
add?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
approve?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
change_role?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
decline?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
errors?: | null
| {
accept?: | null
| { code: string; detail: string; identity_id: string }[];
add?: null | { code: string; detail: string; identity_id: string }[];
approve?:
| null
| { code: string; detail: string; identity_id: string }[];
change_role?:
| null
| { code: string; detail: string; identity_id: string }[];
decline?:
| null
| { code: string; detail: string; identity_id: string }[];
invite?:
| null
| { code: string; detail: string; identity_id: string }[];
join?: null | { code: string; detail: string; identity_id: string }[];
leave?: null | { code: string; detail: string; identity_id: string }[];
reject?:
| null
| { code: string; detail: string; identity_id: string }[];
remove?:
| null
| { code: string; detail: string; identity_id: string }[];
request_join?:
| null
| { code: string; detail: string; identity_id: string }[];
};
invite?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
join?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
leave?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
reject?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
remove?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
request_join?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
};
};
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?: null
| string[];
};
};
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: null
| boolean } };
};
};
responses: {
"200": {
content: {
"application/json": { [key: string]: { allow_add: null
| 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?: null
| string[];
};
};
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?: null
| string;
address1?: null | string;
address2?: null | string;
city?: null | string;
country?: null | string;
current_project_name?: null | string;
department?: null | string;
field_of_science?: null | string;
first_name?: null | string;
institution?: null | string;
last_name?: null | string;
organization?: null | string;
phone?: null | string;
state?: null | string;
zip?: null | string;
};
};
};
};
responses: {
"200": {
content: {
"application/json": {
[key: string]: {
address?: null
| string;
address1?: null | string;
address2?: null | string;
city?: null | string;
country?: null | string;
current_project_name?: null | string;
department?: null | string;
field_of_science?: null | string;
first_name?: null | string;
institution?: null | string;
last_name?: null | string;
organization?: null | string;
phone?: null | string;
state?: null | string;
zip?: null | 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?: null
| string[];
};
};
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?: null
| string;
name?: null | string;
subscription_admin_verified_id?: null | string;
terms_and_conditions?: null | string;
};
};
};
responses: {
"200": {
content: {
"application/json": {
allowed_actions?: | null
| {
accept: string[];
add: string[];
approve: string[];
change_role: string[];
decline: string[];
invite: string[];
join: string[];
leave: string[];
reject: string[];
remove: string[];
request_join: string[];
};
child_ids?: null
| string[];
description?: null | string;
enforce_session: boolean;
group_type: "regular" | "plus";
id: string;
memberships?:
| null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
my_memberships?: | null
| {
group_id: string;
identity_id: string;
invite_email_address?: null
| string;
invite_time?: null | string;
membership_fields: null | { [key: string]: unknown };
role: "manager" | "admin" | "member";
source_group_id?: string;
status:
| "active"
| "invited"
| "pending"
| "rejected"
| "removed"
| "left"
| "declined";
status_reason?: null
| string;
updated?: null | string;
username: string;
}[];
name: string;
parent_id: null
| string;
policies?: {
authentication_assurance_timeout?: null | number;
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?: null
| number;
session_timeouts: {
[key: string]: { expire_time: string; expires_in: number };
};
subscription_admin_verified_id?: null
| string;
subscription_id?: null | string;
subscription_info?:
| null
| {
connectors: { [key: string]: { is_baa: boolean; is_ha: boolean } };
is_baa: boolean;
is_high_assurance: boolean;
name: string;
subscriber_name: string;
};
terms_and_conditions?: null
| 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?: null
| string[];
};
};
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?: null
| number;
group_members_visibility?: null | "members" | "managers";
group_visibility?: null | "authenticated" | "private";
is_high_assurance?: null | boolean;
join_requests?: null | boolean;
signup_fields?:
| null
| (
| "state"
| "department"
| "institution"
| "current_project_name"
| "address"
| "city"
| "country"
| "address1"
| "address2"
| "zip"
| "phone"
| "field_of_science"
)[];
};
};
};
responses: {
"200": {
content: {
"application/json": {
authentication_assurance_timeout?: null
| number;
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?: null
| string[];
};
};
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: null
| string };
};
};
responses: {
"200": {
content: {
"application/json": {
group_id: string;
subscription_admin_verified_id: null
| 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?: null
| string[];
};
};
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 };
};
};
}