@faable/auth-sdk 2.7.83 → 2.7.84
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/FaableAuthApi.d.ts +4 -0
- package/dist/api/generated-client.d.ts +58 -51
- package/dist/api/types.d.ts +320 -1
- package/dist/version.js +2 -2
- package/package.json +1 -1
- package/spec/openapi.json +747 -2
package/dist/api/types.d.ts
CHANGED
|
@@ -1368,6 +1368,26 @@ export interface paths {
|
|
|
1368
1368
|
patch?: never;
|
|
1369
1369
|
trace?: never;
|
|
1370
1370
|
};
|
|
1371
|
+
"/organization/{organization_id}/auto-join": {
|
|
1372
|
+
parameters: {
|
|
1373
|
+
query?: never;
|
|
1374
|
+
header?: never;
|
|
1375
|
+
path?: never;
|
|
1376
|
+
cookie?: never;
|
|
1377
|
+
};
|
|
1378
|
+
get?: never;
|
|
1379
|
+
/**
|
|
1380
|
+
* Set an Organization's auto-join rules
|
|
1381
|
+
* @description Replaces the auto-join rules: whoever signs in with a verified email of one of the verified domains joins these teams (of this organization) with these roles. Nobody already a member is changed. Pro plan to turn it on; an empty list turns it off and is always allowed.
|
|
1382
|
+
*/
|
|
1383
|
+
put: operations["organization/setAutoJoin"];
|
|
1384
|
+
post?: never;
|
|
1385
|
+
delete?: never;
|
|
1386
|
+
options?: never;
|
|
1387
|
+
head?: never;
|
|
1388
|
+
patch?: never;
|
|
1389
|
+
trace?: never;
|
|
1390
|
+
};
|
|
1371
1391
|
"/teammember": {
|
|
1372
1392
|
parameters: {
|
|
1373
1393
|
query?: never;
|
|
@@ -4946,6 +4966,8 @@ export interface components {
|
|
|
4946
4966
|
/** @default null */
|
|
4947
4967
|
response_type: string;
|
|
4948
4968
|
enabled: boolean;
|
|
4969
|
+
/** @description The Organization whose identity provider this is (`organization_…`), or `null`. Only `oidc` connections. Reached by home realm discovery from the organization's verified email domains, and only accepts emails of those domains. Pro plan. */
|
|
4970
|
+
organization?: string | null;
|
|
4949
4971
|
/** @default null */
|
|
4950
4972
|
enabled_clients: string[] | null;
|
|
4951
4973
|
/** @default [] */
|
|
@@ -5008,6 +5030,10 @@ export interface components {
|
|
|
5008
5030
|
client_secret?: string;
|
|
5009
5031
|
issuer?: string;
|
|
5010
5032
|
jwks_url?: string;
|
|
5033
|
+
token_url?: string;
|
|
5034
|
+
userinfo_url?: string;
|
|
5035
|
+
/** @description The Organization whose identity provider this is (`organization_…`), or `null`. Only `oidc` connections. Reached by home realm discovery from the organization's verified email domains, and only accepts emails of those domains. Pro plan. */
|
|
5036
|
+
organization?: string;
|
|
5011
5037
|
scope?: string[];
|
|
5012
5038
|
enabled?: boolean;
|
|
5013
5039
|
claims_mapping?: {
|
|
@@ -5084,6 +5110,7 @@ export interface components {
|
|
|
5084
5110
|
disable_signup?: boolean;
|
|
5085
5111
|
/** @description What users of this database connection sign in with: `email`, `username`, or `email_or_username` (email first, then username). The login looks up only the matching field, and the hosted login screen asks for it — validating the address format under `email`. New database connections default to `email`; a connection created before this setting existed behaves as `email_or_username`. Only meaningful on `database` connections. */
|
|
5086
5112
|
login_identifier?: "email" | "username" | "email_or_username";
|
|
5113
|
+
organization?: string | null;
|
|
5087
5114
|
};
|
|
5088
5115
|
/** @description Presentation metadata for one connection type. Contains no endpoint URLs and no credentials. */
|
|
5089
5116
|
ConnectionTypeInfo: {
|
|
@@ -5863,6 +5890,13 @@ export interface components {
|
|
|
5863
5890
|
*/
|
|
5864
5891
|
verified_at: string | null;
|
|
5865
5892
|
}[];
|
|
5893
|
+
/** @description Whoever signs in with a verified email of one of the verified domains joins these teams. Empty = nobody joins by domain. */
|
|
5894
|
+
auto_join: {
|
|
5895
|
+
/** @description A team of this organization. */
|
|
5896
|
+
team: string;
|
|
5897
|
+
/** @description Role ids the member gets in that team. */
|
|
5898
|
+
roles: string[];
|
|
5899
|
+
}[];
|
|
5866
5900
|
/** @description Ids of the users who manage the organization: its teams and its identity settings. Being an admin does not grant access to any team; team access is team membership. */
|
|
5867
5901
|
admins: string[];
|
|
5868
5902
|
/** @description Object is related with this account */
|
|
@@ -7334,6 +7368,8 @@ export interface components {
|
|
|
7334
7368
|
* - `organization_domain_taken` (409): Another organization of this tenant already verified this domain. A domain belongs to one organization.
|
|
7335
7369
|
* - `organization_domain_unverified` (400): The TXT record was not found or does not hold the expected value yet. `details.record` says what was expected and what resolves now; DNS can take a few minutes to propagate.
|
|
7336
7370
|
* - `plan_unavailable` (503): The plan could not be checked right now, and this setting is only for paid plans. Try again in a minute.
|
|
7371
|
+
* - `organization_domain_mismatch` (403): This organization's identity provider can only sign in addresses of the organization's verified email domains.
|
|
7372
|
+
* - `team_not_in_organization` (400): Auto-join can only put people in teams of the same organization. `details.teams` lists the others.
|
|
7337
7373
|
* - `organization_not_found` (404): No organization with that id in this account.
|
|
7338
7374
|
* - `invalid_user` (400): The user does not exist in this account.
|
|
7339
7375
|
* - `not_an_organization_admin` (404): The user is not an admin of the organization.
|
|
@@ -7351,7 +7387,7 @@ export interface components {
|
|
|
7351
7387
|
* - `delivery_in_progress` (409): The delivery is being attempted right now; retry the redeliver in a minute.
|
|
7352
7388
|
* @enum {string}
|
|
7353
7389
|
*/
|
|
7354
|
-
ErrorCode: "bad_request" | "validation_error" | "unauthorized" | "payment_required" | "forbidden" | "not_found" | "method_not_allowed" | "conflict" | "payload_too_large" | "unsupported_media_type" | "unprocessable_entity" | "too_many_requests" | "internal_error" | "already_exists" | "invalid_id" | "account_not_found" | "invalid_query" | "search_not_supported" | "invalid_expand" | "access_denied" | "insufficient_scope" | "team_required" | "account_limit_reached" | "invalid_project_id" | "account_transfer_refused" | "email_sender_domain_not_allowed" | "plan_required" | "invalid_canonical_host" | "canonical_host_breaks_passkeys" | "not_logged_in" | "session_already_revoked" | "invalid_token" | "not_owner" | "user_suspended" | "invalid_credentials" | "login_denied" | "signup_denied" | "client_credentials_denied" | "m2m_quota_exceeded" | "signup_disabled" | "email_taken" | "username_taken" | "invalid_username" | "invalid_email" | "invalid_name" | "same_email" | "user_has_no_email" | "password_too_weak" | "invalid_password_hash" | "weak_password_hash" | "invalid_code" | "invalid_phone" | "phone_changed" | "phone_already_verified" | "sms_unavailable" | "sms_failed" | "invalid_state" | "state_mismatch" | "invalid_ticket" | "ticket_used" | "ticket_expired" | "ticket_not_found" | "credential_not_found" | "invalid_link" | "expired_link" | "invalid_otp" | "invalid_client" | "client_not_found" | "client_mismatch" | "invalid_client_metadata" | "invalid_connection" | "no_database_connection" | "connection_required" | "connection_misconfigured" | "passwordless_unavailable" | "ambiguous_connection" | "invalid_redirect_uri" | "origin_not_allowed" | "audience_not_found" | "system_resource" | "invalid_request" | "invalid_device_code" | "provider_error" | "identity_already_linked" | "identity_link_denied" | "identity_conflict" | "identity_orphaned" | "no_provider_token" | "no_refresh_token" | "action_unavailable" | "login_flow_misconfigured" | "mfa_required" | "step_up_required" | "interaction_required" | "passkey_login_disabled" | "mfa_pending" | "mfa_invalid_code" | "mfa_invalid_recovery_code" | "too_many_attempts" | "too_many_login_attempts" | "totp_not_allowed" | "no_usable_factor" | "factor_not_found" | "factor_already_confirmed" | "invalid_factor" | "session_missing" | "passkey_verification_failed" | "no_passkey_enrolled" | "malformed_credential" | "unknown_passkey" | "invalid_passkey" | "invalid_invite_url" | "invite_email_mismatch" | "invite_email_unverified" | "invite_not_found" | "invite_used" | "already_member" | "not_a_member" | "registration_disabled" | "invalid_email_domain" | "public_email_domain" | "organization_domain_not_found" | "organization_domain_taken" | "organization_domain_unverified" | "plan_unavailable" | "organization_not_found" | "invalid_user" | "not_an_organization_admin" | "last_organization_admin" | "team_id_unavailable" | "use_team_member_route" | "role_not_found" | "invalid_role" | "flow_not_found" | "revision_not_found" | "invalid_webhook_event" | "invalid_webhook_url" | "not_a_webhook" | "delivery_not_found" | "delivery_in_progress";
|
|
7390
|
+
ErrorCode: "bad_request" | "validation_error" | "unauthorized" | "payment_required" | "forbidden" | "not_found" | "method_not_allowed" | "conflict" | "payload_too_large" | "unsupported_media_type" | "unprocessable_entity" | "too_many_requests" | "internal_error" | "already_exists" | "invalid_id" | "account_not_found" | "invalid_query" | "search_not_supported" | "invalid_expand" | "access_denied" | "insufficient_scope" | "team_required" | "account_limit_reached" | "invalid_project_id" | "account_transfer_refused" | "email_sender_domain_not_allowed" | "plan_required" | "invalid_canonical_host" | "canonical_host_breaks_passkeys" | "not_logged_in" | "session_already_revoked" | "invalid_token" | "not_owner" | "user_suspended" | "invalid_credentials" | "login_denied" | "signup_denied" | "client_credentials_denied" | "m2m_quota_exceeded" | "signup_disabled" | "email_taken" | "username_taken" | "invalid_username" | "invalid_email" | "invalid_name" | "same_email" | "user_has_no_email" | "password_too_weak" | "invalid_password_hash" | "weak_password_hash" | "invalid_code" | "invalid_phone" | "phone_changed" | "phone_already_verified" | "sms_unavailable" | "sms_failed" | "invalid_state" | "state_mismatch" | "invalid_ticket" | "ticket_used" | "ticket_expired" | "ticket_not_found" | "credential_not_found" | "invalid_link" | "expired_link" | "invalid_otp" | "invalid_client" | "client_not_found" | "client_mismatch" | "invalid_client_metadata" | "invalid_connection" | "no_database_connection" | "connection_required" | "connection_misconfigured" | "passwordless_unavailable" | "ambiguous_connection" | "invalid_redirect_uri" | "origin_not_allowed" | "audience_not_found" | "system_resource" | "invalid_request" | "invalid_device_code" | "provider_error" | "identity_already_linked" | "identity_link_denied" | "identity_conflict" | "identity_orphaned" | "no_provider_token" | "no_refresh_token" | "action_unavailable" | "login_flow_misconfigured" | "mfa_required" | "step_up_required" | "interaction_required" | "passkey_login_disabled" | "mfa_pending" | "mfa_invalid_code" | "mfa_invalid_recovery_code" | "too_many_attempts" | "too_many_login_attempts" | "totp_not_allowed" | "no_usable_factor" | "factor_not_found" | "factor_already_confirmed" | "invalid_factor" | "session_missing" | "passkey_verification_failed" | "no_passkey_enrolled" | "malformed_credential" | "unknown_passkey" | "invalid_passkey" | "invalid_invite_url" | "invite_email_mismatch" | "invite_email_unverified" | "invite_not_found" | "invite_used" | "already_member" | "not_a_member" | "registration_disabled" | "invalid_email_domain" | "public_email_domain" | "organization_domain_not_found" | "organization_domain_taken" | "organization_domain_unverified" | "plan_unavailable" | "organization_domain_mismatch" | "team_not_in_organization" | "organization_not_found" | "invalid_user" | "not_an_organization_admin" | "last_organization_admin" | "team_id_unavailable" | "use_team_member_route" | "role_not_found" | "invalid_role" | "flow_not_found" | "revision_not_found" | "invalid_webhook_event" | "invalid_webhook_url" | "not_a_webhook" | "delivery_not_found" | "delivery_in_progress";
|
|
7355
7391
|
/** @description Every error response has this shape. Branch on `error_code`, never on `message`: the message is written for a person and may change. */
|
|
7356
7392
|
ErrorResponse: {
|
|
7357
7393
|
/** @description The HTTP status, repeated. */
|
|
@@ -9938,6 +9974,10 @@ export interface operations {
|
|
|
9938
9974
|
client_secret?: string;
|
|
9939
9975
|
issuer?: string;
|
|
9940
9976
|
jwks_url?: string;
|
|
9977
|
+
token_url?: string;
|
|
9978
|
+
userinfo_url?: string;
|
|
9979
|
+
/** @description The Organization whose identity provider this is (`organization_…`), or `null`. Only `oidc` connections. Reached by home realm discovery from the organization's verified email domains, and only accepts emails of those domains. Pro plan. */
|
|
9980
|
+
organization?: string;
|
|
9941
9981
|
scope?: string[];
|
|
9942
9982
|
enabled?: boolean;
|
|
9943
9983
|
claims_mapping?: {
|
|
@@ -10006,6 +10046,8 @@ export interface operations {
|
|
|
10006
10046
|
/** @default null */
|
|
10007
10047
|
response_type: string;
|
|
10008
10048
|
enabled: boolean;
|
|
10049
|
+
/** @description The Organization whose identity provider this is (`organization_…`), or `null`. Only `oidc` connections. Reached by home realm discovery from the organization's verified email domains, and only accepts emails of those domains. Pro plan. */
|
|
10050
|
+
organization?: string | null;
|
|
10009
10051
|
/** @default null */
|
|
10010
10052
|
enabled_clients: string[] | null;
|
|
10011
10053
|
/** @default [] */
|
|
@@ -10177,6 +10219,8 @@ export interface operations {
|
|
|
10177
10219
|
/** @default null */
|
|
10178
10220
|
response_type: string;
|
|
10179
10221
|
enabled: boolean;
|
|
10222
|
+
/** @description The Organization whose identity provider this is (`organization_…`), or `null`. Only `oidc` connections. Reached by home realm discovery from the organization's verified email domains, and only accepts emails of those domains. Pro plan. */
|
|
10223
|
+
organization?: string | null;
|
|
10180
10224
|
/** @default null */
|
|
10181
10225
|
enabled_clients: string[] | null;
|
|
10182
10226
|
/** @default [] */
|
|
@@ -10361,6 +10405,7 @@ export interface operations {
|
|
|
10361
10405
|
disable_signup?: boolean;
|
|
10362
10406
|
/** @description What users of this database connection sign in with: `email`, `username`, or `email_or_username` (email first, then username). The login looks up only the matching field, and the hosted login screen asks for it — validating the address format under `email`. New database connections default to `email`; a connection created before this setting existed behaves as `email_or_username`. Only meaningful on `database` connections. */
|
|
10363
10407
|
login_identifier?: "email" | "username" | "email_or_username";
|
|
10408
|
+
organization?: string | null;
|
|
10364
10409
|
};
|
|
10365
10410
|
};
|
|
10366
10411
|
};
|
|
@@ -10394,6 +10439,8 @@ export interface operations {
|
|
|
10394
10439
|
/** @default null */
|
|
10395
10440
|
response_type: string;
|
|
10396
10441
|
enabled: boolean;
|
|
10442
|
+
/** @description The Organization whose identity provider this is (`organization_…`), or `null`. Only `oidc` connections. Reached by home realm discovery from the organization's verified email domains, and only accepts emails of those domains. Pro plan. */
|
|
10443
|
+
organization?: string | null;
|
|
10397
10444
|
/** @default null */
|
|
10398
10445
|
enabled_clients: string[] | null;
|
|
10399
10446
|
/** @default [] */
|
|
@@ -10571,6 +10618,8 @@ export interface operations {
|
|
|
10571
10618
|
/** @default null */
|
|
10572
10619
|
response_type: string;
|
|
10573
10620
|
enabled: boolean;
|
|
10621
|
+
/** @description The Organization whose identity provider this is (`organization_…`), or `null`. Only `oidc` connections. Reached by home realm discovery from the organization's verified email domains, and only accepts emails of those domains. Pro plan. */
|
|
10622
|
+
organization?: string | null;
|
|
10574
10623
|
/** @default null */
|
|
10575
10624
|
enabled_clients: string[] | null;
|
|
10576
10625
|
/** @default [] */
|
|
@@ -10892,6 +10941,15 @@ export interface operations {
|
|
|
10892
10941
|
content: {
|
|
10893
10942
|
"application/json": {
|
|
10894
10943
|
ok: boolean;
|
|
10944
|
+
/** @description The identifier is an email of an organization's verified domain, and that organization has its own identity provider: continue with `/authorize?resume_state=<state>&connection=<connection_id>` instead of the method chooser (arch/auth/sso.md F3). */
|
|
10945
|
+
home_realm?: {
|
|
10946
|
+
connection_id: string;
|
|
10947
|
+
organization: {
|
|
10948
|
+
id: string;
|
|
10949
|
+
name: string;
|
|
10950
|
+
logo_url: string | null;
|
|
10951
|
+
};
|
|
10952
|
+
};
|
|
10895
10953
|
};
|
|
10896
10954
|
};
|
|
10897
10955
|
};
|
|
@@ -19105,6 +19163,13 @@ export interface operations {
|
|
|
19105
19163
|
*/
|
|
19106
19164
|
verified_at: string | null;
|
|
19107
19165
|
}[];
|
|
19166
|
+
/** @description Whoever signs in with a verified email of one of the verified domains joins these teams. Empty = nobody joins by domain. */
|
|
19167
|
+
auto_join: {
|
|
19168
|
+
/** @description A team of this organization. */
|
|
19169
|
+
team: string;
|
|
19170
|
+
/** @description Role ids the member gets in that team. */
|
|
19171
|
+
roles: string[];
|
|
19172
|
+
}[];
|
|
19108
19173
|
/** @description Ids of the users who manage the organization: its teams and its identity settings. Being an admin does not grant access to any team; team access is team membership. */
|
|
19109
19174
|
admins: string[];
|
|
19110
19175
|
/** @description Object is related with this account */
|
|
@@ -19253,6 +19318,13 @@ export interface operations {
|
|
|
19253
19318
|
*/
|
|
19254
19319
|
verified_at: string | null;
|
|
19255
19320
|
}[];
|
|
19321
|
+
/** @description Whoever signs in with a verified email of one of the verified domains joins these teams. Empty = nobody joins by domain. */
|
|
19322
|
+
auto_join: {
|
|
19323
|
+
/** @description A team of this organization. */
|
|
19324
|
+
team: string;
|
|
19325
|
+
/** @description Role ids the member gets in that team. */
|
|
19326
|
+
roles: string[];
|
|
19327
|
+
}[];
|
|
19256
19328
|
/** @description Ids of the users who manage the organization: its teams and its identity settings. Being an admin does not grant access to any team; team access is team membership. */
|
|
19257
19329
|
admins: string[];
|
|
19258
19330
|
/** @description Object is related with this account */
|
|
@@ -19426,6 +19498,13 @@ export interface operations {
|
|
|
19426
19498
|
*/
|
|
19427
19499
|
verified_at: string | null;
|
|
19428
19500
|
}[];
|
|
19501
|
+
/** @description Whoever signs in with a verified email of one of the verified domains joins these teams. Empty = nobody joins by domain. */
|
|
19502
|
+
auto_join: {
|
|
19503
|
+
/** @description A team of this organization. */
|
|
19504
|
+
team: string;
|
|
19505
|
+
/** @description Role ids the member gets in that team. */
|
|
19506
|
+
roles: string[];
|
|
19507
|
+
}[];
|
|
19429
19508
|
/** @description Ids of the users who manage the organization: its teams and its identity settings. Being an admin does not grant access to any team; team access is team membership. */
|
|
19430
19509
|
admins: string[];
|
|
19431
19510
|
/** @description Object is related with this account */
|
|
@@ -19580,6 +19659,13 @@ export interface operations {
|
|
|
19580
19659
|
*/
|
|
19581
19660
|
verified_at: string | null;
|
|
19582
19661
|
}[];
|
|
19662
|
+
/** @description Whoever signs in with a verified email of one of the verified domains joins these teams. Empty = nobody joins by domain. */
|
|
19663
|
+
auto_join: {
|
|
19664
|
+
/** @description A team of this organization. */
|
|
19665
|
+
team: string;
|
|
19666
|
+
/** @description Role ids the member gets in that team. */
|
|
19667
|
+
roles: string[];
|
|
19668
|
+
}[];
|
|
19583
19669
|
/** @description Ids of the users who manage the organization: its teams and its identity settings. Being an admin does not grant access to any team; team access is team membership. */
|
|
19584
19670
|
admins: string[];
|
|
19585
19671
|
/** @description Object is related with this account */
|
|
@@ -19742,6 +19828,13 @@ export interface operations {
|
|
|
19742
19828
|
*/
|
|
19743
19829
|
verified_at: string | null;
|
|
19744
19830
|
}[];
|
|
19831
|
+
/** @description Whoever signs in with a verified email of one of the verified domains joins these teams. Empty = nobody joins by domain. */
|
|
19832
|
+
auto_join: {
|
|
19833
|
+
/** @description A team of this organization. */
|
|
19834
|
+
team: string;
|
|
19835
|
+
/** @description Role ids the member gets in that team. */
|
|
19836
|
+
roles: string[];
|
|
19837
|
+
}[];
|
|
19745
19838
|
/** @description Ids of the users who manage the organization: its teams and its identity settings. Being an admin does not grant access to any team; team access is team membership. */
|
|
19746
19839
|
admins: string[];
|
|
19747
19840
|
/** @description Object is related with this account */
|
|
@@ -19895,6 +19988,13 @@ export interface operations {
|
|
|
19895
19988
|
*/
|
|
19896
19989
|
verified_at: string | null;
|
|
19897
19990
|
}[];
|
|
19991
|
+
/** @description Whoever signs in with a verified email of one of the verified domains joins these teams. Empty = nobody joins by domain. */
|
|
19992
|
+
auto_join: {
|
|
19993
|
+
/** @description A team of this organization. */
|
|
19994
|
+
team: string;
|
|
19995
|
+
/** @description Role ids the member gets in that team. */
|
|
19996
|
+
roles: string[];
|
|
19997
|
+
}[];
|
|
19898
19998
|
/** @description Ids of the users who manage the organization: its teams and its identity settings. Being an admin does not grant access to any team; team access is team membership. */
|
|
19899
19999
|
admins: string[];
|
|
19900
20000
|
/** @description Object is related with this account */
|
|
@@ -20067,6 +20167,13 @@ export interface operations {
|
|
|
20067
20167
|
*/
|
|
20068
20168
|
verified_at: string | null;
|
|
20069
20169
|
}[];
|
|
20170
|
+
/** @description Whoever signs in with a verified email of one of the verified domains joins these teams. Empty = nobody joins by domain. */
|
|
20171
|
+
auto_join: {
|
|
20172
|
+
/** @description A team of this organization. */
|
|
20173
|
+
team: string;
|
|
20174
|
+
/** @description Role ids the member gets in that team. */
|
|
20175
|
+
roles: string[];
|
|
20176
|
+
}[];
|
|
20070
20177
|
/** @description Ids of the users who manage the organization: its teams and its identity settings. Being an admin does not grant access to any team; team access is team membership. */
|
|
20071
20178
|
admins: string[];
|
|
20072
20179
|
/** @description Object is related with this account */
|
|
@@ -20224,6 +20331,13 @@ export interface operations {
|
|
|
20224
20331
|
*/
|
|
20225
20332
|
verified_at: string | null;
|
|
20226
20333
|
}[];
|
|
20334
|
+
/** @description Whoever signs in with a verified email of one of the verified domains joins these teams. Empty = nobody joins by domain. */
|
|
20335
|
+
auto_join: {
|
|
20336
|
+
/** @description A team of this organization. */
|
|
20337
|
+
team: string;
|
|
20338
|
+
/** @description Role ids the member gets in that team. */
|
|
20339
|
+
roles: string[];
|
|
20340
|
+
}[];
|
|
20227
20341
|
/** @description Ids of the users who manage the organization: its teams and its identity settings. Being an admin does not grant access to any team; team access is team membership. */
|
|
20228
20342
|
admins: string[];
|
|
20229
20343
|
/** @description Object is related with this account */
|
|
@@ -20429,6 +20543,13 @@ export interface operations {
|
|
|
20429
20543
|
*/
|
|
20430
20544
|
verified_at: string | null;
|
|
20431
20545
|
}[];
|
|
20546
|
+
/** @description Whoever signs in with a verified email of one of the verified domains joins these teams. Empty = nobody joins by domain. */
|
|
20547
|
+
auto_join: {
|
|
20548
|
+
/** @description A team of this organization. */
|
|
20549
|
+
team: string;
|
|
20550
|
+
/** @description Role ids the member gets in that team. */
|
|
20551
|
+
roles: string[];
|
|
20552
|
+
}[];
|
|
20432
20553
|
/** @description Ids of the users who manage the organization: its teams and its identity settings. Being an admin does not grant access to any team; team access is team membership. */
|
|
20433
20554
|
admins: string[];
|
|
20434
20555
|
/** @description Object is related with this account */
|
|
@@ -20533,6 +20654,204 @@ export interface operations {
|
|
|
20533
20654
|
};
|
|
20534
20655
|
};
|
|
20535
20656
|
};
|
|
20657
|
+
"organization/setAutoJoin": {
|
|
20658
|
+
parameters: {
|
|
20659
|
+
query?: never;
|
|
20660
|
+
header?: never;
|
|
20661
|
+
path: {
|
|
20662
|
+
organization_id: string;
|
|
20663
|
+
};
|
|
20664
|
+
cookie?: never;
|
|
20665
|
+
};
|
|
20666
|
+
requestBody: {
|
|
20667
|
+
content: {
|
|
20668
|
+
"application/json": {
|
|
20669
|
+
auto_join: {
|
|
20670
|
+
/** @description A team of this organization. */
|
|
20671
|
+
team: string;
|
|
20672
|
+
/** @description Role ids of this tenant. */
|
|
20673
|
+
roles: string[];
|
|
20674
|
+
}[];
|
|
20675
|
+
};
|
|
20676
|
+
};
|
|
20677
|
+
};
|
|
20678
|
+
responses: {
|
|
20679
|
+
/** @description Organization */
|
|
20680
|
+
200: {
|
|
20681
|
+
headers: {
|
|
20682
|
+
[name: string]: unknown;
|
|
20683
|
+
};
|
|
20684
|
+
content: {
|
|
20685
|
+
"application/json": {
|
|
20686
|
+
/** @description Organization ID */
|
|
20687
|
+
id: string;
|
|
20688
|
+
/**
|
|
20689
|
+
* @description Human-readable name of the organization.
|
|
20690
|
+
* @example Acme Inc.
|
|
20691
|
+
*/
|
|
20692
|
+
name: string;
|
|
20693
|
+
/**
|
|
20694
|
+
* @description URL-safe identifier derived from `name`. Unique within the tenant.
|
|
20695
|
+
* @example acme-inc
|
|
20696
|
+
*/
|
|
20697
|
+
slug: string;
|
|
20698
|
+
/** @description Optional free-form description. */
|
|
20699
|
+
description: string | null;
|
|
20700
|
+
/** @description Optional URL of the organization logo. */
|
|
20701
|
+
logo_url: string | null;
|
|
20702
|
+
/** @description Email domains the organization claims. Only a verified one counts: it is how the organization's people are recognized. */
|
|
20703
|
+
domains: {
|
|
20704
|
+
/** @example acme.com */
|
|
20705
|
+
domain: string;
|
|
20706
|
+
/** @description Put `faable-verification=<verification_token>` in a TXT record at `_faable-challenge.<domain>`, then call `POST /organization/{organization_id}/domain/{domain}/verify`. */
|
|
20707
|
+
verification_token: string;
|
|
20708
|
+
/**
|
|
20709
|
+
* Format: date-time
|
|
20710
|
+
* @description When the TXT record was found. `null` = not verified.
|
|
20711
|
+
*/
|
|
20712
|
+
verified_at: string | null;
|
|
20713
|
+
}[];
|
|
20714
|
+
/** @description Whoever signs in with a verified email of one of the verified domains joins these teams. Empty = nobody joins by domain. */
|
|
20715
|
+
auto_join: {
|
|
20716
|
+
/** @description A team of this organization. */
|
|
20717
|
+
team: string;
|
|
20718
|
+
/** @description Role ids the member gets in that team. */
|
|
20719
|
+
roles: string[];
|
|
20720
|
+
}[];
|
|
20721
|
+
/** @description Ids of the users who manage the organization: its teams and its identity settings. Being an admin does not grant access to any team; team access is team membership. */
|
|
20722
|
+
admins: string[];
|
|
20723
|
+
/** @description Object is related with this account */
|
|
20724
|
+
account: string;
|
|
20725
|
+
/**
|
|
20726
|
+
* @description OrganizationMetadata
|
|
20727
|
+
* @default {}
|
|
20728
|
+
*/
|
|
20729
|
+
metadata: {
|
|
20730
|
+
[key: string]: unknown;
|
|
20731
|
+
};
|
|
20732
|
+
/** @description Organization creation date */
|
|
20733
|
+
createdAt: string;
|
|
20734
|
+
/** @description Organization updated date */
|
|
20735
|
+
updatedAt?: string;
|
|
20736
|
+
};
|
|
20737
|
+
};
|
|
20738
|
+
};
|
|
20739
|
+
/**
|
|
20740
|
+
* @description `team_not_in_organization` — Auto-join can only put people in teams of the same organization. `details.teams` lists the others.
|
|
20741
|
+
*
|
|
20742
|
+
* `invalid_role` — The role belongs to another account.
|
|
20743
|
+
*
|
|
20744
|
+
* `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.
|
|
20745
|
+
*/
|
|
20746
|
+
400: {
|
|
20747
|
+
headers: {
|
|
20748
|
+
[name: string]: unknown;
|
|
20749
|
+
};
|
|
20750
|
+
content: {
|
|
20751
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
20752
|
+
/** @enum {string} */
|
|
20753
|
+
error_code?: "team_not_in_organization" | "invalid_role" | "validation_error";
|
|
20754
|
+
};
|
|
20755
|
+
};
|
|
20756
|
+
};
|
|
20757
|
+
/** @description `unauthorized` — The request carries no valid credentials. */
|
|
20758
|
+
401: {
|
|
20759
|
+
headers: {
|
|
20760
|
+
[name: string]: unknown;
|
|
20761
|
+
};
|
|
20762
|
+
content: {
|
|
20763
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
20764
|
+
/** @enum {string} */
|
|
20765
|
+
error_code?: "unauthorized";
|
|
20766
|
+
};
|
|
20767
|
+
};
|
|
20768
|
+
};
|
|
20769
|
+
/** @description `plan_required` — The setting requires a higher plan. `message` says which. */
|
|
20770
|
+
402: {
|
|
20771
|
+
headers: {
|
|
20772
|
+
[name: string]: unknown;
|
|
20773
|
+
};
|
|
20774
|
+
content: {
|
|
20775
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
20776
|
+
/** @enum {string} */
|
|
20777
|
+
error_code?: "plan_required";
|
|
20778
|
+
};
|
|
20779
|
+
};
|
|
20780
|
+
};
|
|
20781
|
+
/**
|
|
20782
|
+
* @description `forbidden` — The credentials are valid but do not allow this operation.
|
|
20783
|
+
*
|
|
20784
|
+
* `insufficient_scope` — The token lacks a scope this operation requires. `message` names it.
|
|
20785
|
+
*
|
|
20786
|
+
* `user_suspended` — The user is suspended and cannot sign in or be modified.
|
|
20787
|
+
*/
|
|
20788
|
+
403: {
|
|
20789
|
+
headers: {
|
|
20790
|
+
[name: string]: unknown;
|
|
20791
|
+
};
|
|
20792
|
+
content: {
|
|
20793
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
20794
|
+
/** @enum {string} */
|
|
20795
|
+
error_code?: "forbidden" | "insufficient_scope" | "user_suspended";
|
|
20796
|
+
};
|
|
20797
|
+
};
|
|
20798
|
+
};
|
|
20799
|
+
/**
|
|
20800
|
+
* @description `organization_not_found` — No organization with that id in this account.
|
|
20801
|
+
*
|
|
20802
|
+
* `role_not_found` — No role with that id in this account.
|
|
20803
|
+
*
|
|
20804
|
+
* `account_not_found` — No Auth Account matches the request (domain, header or token).
|
|
20805
|
+
*/
|
|
20806
|
+
404: {
|
|
20807
|
+
headers: {
|
|
20808
|
+
[name: string]: unknown;
|
|
20809
|
+
};
|
|
20810
|
+
content: {
|
|
20811
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
20812
|
+
/** @enum {string} */
|
|
20813
|
+
error_code?: "organization_not_found" | "role_not_found" | "account_not_found";
|
|
20814
|
+
};
|
|
20815
|
+
};
|
|
20816
|
+
};
|
|
20817
|
+
/** @description `too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header. */
|
|
20818
|
+
429: {
|
|
20819
|
+
headers: {
|
|
20820
|
+
[name: string]: unknown;
|
|
20821
|
+
};
|
|
20822
|
+
content: {
|
|
20823
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
20824
|
+
/** @enum {string} */
|
|
20825
|
+
error_code?: "too_many_requests";
|
|
20826
|
+
};
|
|
20827
|
+
};
|
|
20828
|
+
};
|
|
20829
|
+
/** @description `internal_error` — Unexpected server error. Retry later; the request id is logged. */
|
|
20830
|
+
500: {
|
|
20831
|
+
headers: {
|
|
20832
|
+
[name: string]: unknown;
|
|
20833
|
+
};
|
|
20834
|
+
content: {
|
|
20835
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
20836
|
+
/** @enum {string} */
|
|
20837
|
+
error_code?: "internal_error";
|
|
20838
|
+
};
|
|
20839
|
+
};
|
|
20840
|
+
};
|
|
20841
|
+
/** @description `plan_unavailable` — The plan could not be checked right now, and this setting is only for paid plans. Try again in a minute. */
|
|
20842
|
+
503: {
|
|
20843
|
+
headers: {
|
|
20844
|
+
[name: string]: unknown;
|
|
20845
|
+
};
|
|
20846
|
+
content: {
|
|
20847
|
+
"application/json": components["schemas"]["ErrorResponse"] & {
|
|
20848
|
+
/** @enum {string} */
|
|
20849
|
+
error_code?: "plan_unavailable";
|
|
20850
|
+
};
|
|
20851
|
+
};
|
|
20852
|
+
};
|
|
20853
|
+
};
|
|
20854
|
+
};
|
|
20536
20855
|
"teammember/list": {
|
|
20537
20856
|
parameters: {
|
|
20538
20857
|
query?: {
|
package/dist/version.js
CHANGED
|
@@ -9,13 +9,13 @@
|
|
|
9
9
|
// login pages could not import the SDK at all. Same pattern as auth-js.
|
|
10
10
|
//
|
|
11
11
|
// The sentinels MUST stay byte-identical to the `from` values in `.releaserc`.
|
|
12
|
-
export const version = "2.7.
|
|
12
|
+
export const version = "2.7.84";
|
|
13
13
|
// Short git SHA of the released commit. The version dates a build; this names
|
|
14
14
|
// the exact tree, so a canonical log line or an audit entry leads straight to
|
|
15
15
|
// `git show <sha>`. Deliberately NOT hex: an unreleased build (dev, a local
|
|
16
16
|
// link) cannot be mistaken for a real commit — auth only records values that
|
|
17
17
|
// look like a SHA, and this one never will.
|
|
18
|
-
export const commit = "
|
|
18
|
+
export const commit = "2985002";
|
|
19
19
|
// What this SDK writes in `x-faable-client`. Exported for a consumer that
|
|
20
20
|
// builds a strategy on its own (outside `FaableAuthApi`) and still wants the
|
|
21
21
|
// token request attributed — a bare `authClientCredentials` stamps only what
|