Skip to content

Commit 153531a

Browse files
aeneasraeneasr
committed
docs: bump to 165cc076379abfc37f155e74b1cb096a94390e2b
1 parent f7117fc commit 153531a

File tree

1 file changed

+117
-28
lines changed

1 file changed

+117
-28
lines changed

‎docs/reference/api.json‎

Lines changed: 117 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3012,34 +3012,6 @@
30123012
"required": ["project_id"],
30133013
"type": "object"
30143014
},
3015-
"internalProvisionMockSubscription": {
3016-
"description": "Internal Provision Mock Subscription Request Body",
3017-
"properties": {
3018-
"currency": {
3019-
"description": "Currency\nusd USD\neur Euro",
3020-
"enum": ["usd", "eur"],
3021-
"type": "string",
3022-
"x-go-enum-desc": "usd USD\neur Euro"
3023-
},
3024-
"identity_id": {
3025-
"description": "Identity ID",
3026-
"format": "uuid",
3027-
"type": "string"
3028-
},
3029-
"interval": {
3030-
"description": "Billing Interval\nmonthly Monthly\nyearly Yearly",
3031-
"enum": ["monthly", "yearly"],
3032-
"type": "string",
3033-
"x-go-enum-desc": "monthly Monthly\nyearly Yearly"
3034-
},
3035-
"plan": {
3036-
"description": "Plan ID",
3037-
"type": "string"
3038-
}
3039-
},
3040-
"required": ["plan", "interval", "identity_id", "currency"],
3041-
"type": "object"
3042-
},
30433015
"introspectedOAuth2Token": {
30443016
"description": "Introspection contains an access token's session data as specified by\n[IETF RFC 7662](https://tools.ietf.org/html/rfc7662)",
30453017
"properties": {
@@ -3372,6 +3344,10 @@
33723344
"state": {
33733345
"description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method to sign in with\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the login challenge was passed."
33743346
},
3347+
"transient_payload": {
3348+
"description": "TransientPayload is used to pass data from the login to hooks and email templates",
3349+
"type": "object"
3350+
},
33753351
"type": {
33763352
"$ref": "#/components/schemas/selfServiceFlowType"
33773353
},
@@ -5783,6 +5759,18 @@
57835759
"description": "Get Permissions on Project Request Parameters",
57845760
"type": "object"
57855761
},
5762+
"permissionsOnWorkpaceResponse": {
5763+
"description": "Get Permissions on Project Request Parameters",
5764+
"properties": {
5765+
"permissions": {
5766+
"additionalProperties": {
5767+
"type": "boolean"
5768+
},
5769+
"type": "object"
5770+
}
5771+
},
5772+
"type": "object"
5773+
},
57865774
"plans": {
57875775
"$ref": "#/components/schemas/Pricing"
57885776
},
@@ -6586,6 +6574,10 @@
65866574
"state": {
65876575
"description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method (e.g. recover account via email)\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the recovery challenge was passed."
65886576
},
6577+
"transient_payload": {
6578+
"description": "TransientPayload is used to pass data from the recovery flow to hooks and email templates",
6579+
"type": "object"
6580+
},
65896581
"type": {
65906582
"$ref": "#/components/schemas/selfServiceFlowType"
65916583
},
@@ -7176,6 +7168,10 @@
71767168
"state": {
71777169
"description": "State represents the state of this flow. It knows two states:\n\nshow_form: No user data has been collected, or it is invalid, and thus the form should be shown.\nsuccess: Indicates that the settings flow has been updated successfully with the provided data.\nDone will stay true when repeatedly checking. If set to true, done will revert back to false only\nwhen a flow with invalid (e.g. \"please use a valid phone number\") data was sent."
71787170
},
7171+
"transient_payload": {
7172+
"description": "TransientPayload is used to pass data from the settings flow to hooks and email templates",
7173+
"type": "object"
7174+
},
71797175
"type": {
71807176
"$ref": "#/components/schemas/selfServiceFlowType"
71817177
},
@@ -7955,6 +7951,10 @@
79557951
"resend": {
79567952
"description": "Resend is set when the user wants to resend the code",
79577953
"type": "string"
7954+
},
7955+
"transient_payload": {
7956+
"description": "Transient data to pass along to any webhooks",
7957+
"type": "object"
79587958
}
79597959
},
79607960
"required": ["method", "csrf_token"],
@@ -8006,6 +8006,10 @@
80068006
"description": "The identity traits. This is a placeholder for the registration flow.",
80078007
"type": "object"
80088008
},
8009+
"transient_payload": {
8010+
"description": "Transient data to pass along to any webhooks",
8011+
"type": "object"
8012+
},
80098013
"upstream_parameters": {
80108014
"description": "UpstreamParameters are the parameters that are passed to the upstream identity provider.\n\nThese parameters are optional and depend on what the upstream identity provider supports.\nSupported parameters are:\n`login_hint` (string): The `login_hint` parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session.\n`hd` (string): The `hd` parameter limits the login/registration process to a Google Organization, e.g. `mycollege.edu`.\n`prompt` (string): The `prompt` specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g. `select_account`.",
80118015
"type": "object"
@@ -8036,6 +8040,10 @@
80368040
"password_identifier": {
80378041
"description": "Identifier is the email or username of the user trying to log in.\nThis field is deprecated!",
80388042
"type": "string"
8043+
},
8044+
"transient_payload": {
8045+
"description": "Transient data to pass along to any webhooks",
8046+
"type": "object"
80398047
}
80408048
},
80418049
"required": ["method", "password", "identifier"],
@@ -8055,6 +8063,10 @@
80558063
"totp_code": {
80568064
"description": "The TOTP code.",
80578065
"type": "string"
8066+
},
8067+
"transient_payload": {
8068+
"description": "Transient data to pass along to any webhooks",
8069+
"type": "object"
80588070
}
80598071
},
80608072
"required": ["method", "totp_code"],
@@ -8075,6 +8087,10 @@
80758087
"description": "Method should be set to \"webAuthn\" when logging in using the WebAuthn strategy.",
80768088
"type": "string"
80778089
},
8090+
"transient_payload": {
8091+
"description": "Transient data to pass along to any webhooks",
8092+
"type": "object"
8093+
},
80788094
"webauthn_login": {
80798095
"description": "Login a WebAuthn Security Key\n\nThis must contain the ID of the WebAuthN connection.",
80808096
"type": "string"
@@ -8121,6 +8137,10 @@
81218137
"enum": ["link", "code"],
81228138
"type": "string",
81238139
"x-go-enum-desc": "link RecoveryStrategyLink\ncode RecoveryStrategyCode"
8140+
},
8141+
"transient_payload": {
8142+
"description": "Transient data to pass along to any webhooks",
8143+
"type": "object"
81248144
}
81258145
},
81268146
"required": ["method"],
@@ -8142,6 +8162,10 @@
81428162
"enum": ["link", "code"],
81438163
"type": "string",
81448164
"x-go-enum-desc": "link RecoveryStrategyLink\ncode RecoveryStrategyCode"
8165+
},
8166+
"transient_payload": {
8167+
"description": "Transient data to pass along to any webhooks",
8168+
"type": "object"
81458169
}
81468170
},
81478171
"required": ["email", "method"],
@@ -8364,6 +8388,10 @@
83648388
"method": {
83658389
"description": "Method\n\nShould be set to \"lookup\" when trying to add, update, or remove a lookup pairing.",
83668390
"type": "string"
8391+
},
8392+
"transient_payload": {
8393+
"description": "Transient data to pass along to any webhooks",
8394+
"type": "object"
83678395
}
83688396
},
83698397
"required": ["method"],
@@ -8388,6 +8416,10 @@
83888416
"description": "The identity's traits\n\nin: body",
83898417
"type": "object"
83908418
},
8419+
"transient_payload": {
8420+
"description": "Transient data to pass along to any webhooks",
8421+
"type": "object"
8422+
},
83918423
"unlink": {
83928424
"description": "Unlink this provider\n\nEither this or `link` must be set.\n\ntype: string\nin: body",
83938425
"type": "string"
@@ -8414,6 +8446,10 @@
84148446
"password": {
84158447
"description": "Password is the updated password",
84168448
"type": "string"
8449+
},
8450+
"transient_payload": {
8451+
"description": "Transient data to pass along to any webhooks",
8452+
"type": "object"
84178453
}
84188454
},
84198455
"required": ["password", "method"],
@@ -8433,6 +8469,10 @@
84338469
"traits": {
84348470
"description": "Traits\n\nThe identity's traits.",
84358471
"type": "object"
8472+
},
8473+
"transient_payload": {
8474+
"description": "Transient data to pass along to any webhooks",
8475+
"type": "object"
84368476
}
84378477
},
84388478
"required": ["traits", "method"],
@@ -8456,6 +8496,10 @@
84568496
"totp_unlink": {
84578497
"description": "UnlinkTOTP if true will remove the TOTP pairing,\neffectively removing the credential. This can be used\nto set up a new TOTP device.",
84588498
"type": "boolean"
8499+
},
8500+
"transient_payload": {
8501+
"description": "Transient data to pass along to any webhooks",
8502+
"type": "object"
84598503
}
84608504
},
84618505
"required": ["method"],
@@ -8472,6 +8516,10 @@
84728516
"description": "Method\n\nShould be set to \"webauthn\" when trying to add, update, or remove a webAuthn pairing.",
84738517
"type": "string"
84748518
},
8519+
"transient_payload": {
8520+
"description": "Transient data to pass along to any webhooks",
8521+
"type": "object"
8522+
},
84758523
"webauthn_register": {
84768524
"description": "Register a WebAuthn Security Key\n\nIt is expected that the JSON returned by the WebAuthn registration process\nis included here.",
84778525
"type": "string"
@@ -8543,6 +8591,10 @@
85438591
"enum": ["link", "code"],
85448592
"type": "string",
85458593
"x-go-enum-desc": "link VerificationStrategyLink\ncode VerificationStrategyCode"
8594+
},
8595+
"transient_payload": {
8596+
"description": "Transient data to pass along to any webhooks",
8597+
"type": "object"
85468598
}
85478599
},
85488600
"required": ["method"],
@@ -8564,11 +8616,25 @@
85648616
"enum": ["link", "code"],
85658617
"type": "string",
85668618
"x-go-enum-desc": "link VerificationStrategyLink\ncode VerificationStrategyCode"
8619+
},
8620+
"transient_payload": {
8621+
"description": "Transient data to pass along to any webhooks",
8622+
"type": "object"
85678623
}
85688624
},
85698625
"required": ["email", "method"],
85708626
"type": "object"
85718627
},
8628+
"updateWorkspacePayload": {
8629+
"properties": {
8630+
"name": {
8631+
"description": "The name of the workspace.",
8632+
"type": "string"
8633+
}
8634+
},
8635+
"required": ["name"],
8636+
"type": "object"
8637+
},
85728638
"verifiableCredentialPrimingResponse": {
85738639
"properties": {
85748640
"c_nonce": {
@@ -8691,6 +8757,10 @@
86918757
"state": {
86928758
"description": "State represents the state of this request:\n\nchoose_method: ask the user to choose a method (e.g. verify your email)\nsent_email: the email has been sent to the user\npassed_challenge: the request was successful and the verification challenge was passed."
86938759
},
8760+
"transient_payload": {
8761+
"description": "TransientPayload is used to pass data from the verification flow to hooks and email templates",
8762+
"type": "object"
8763+
},
86948764
"type": {
86958765
"$ref": "#/components/schemas/selfServiceFlowType"
86968766
},
@@ -9459,6 +9529,17 @@
94599529
"schema": {
94609530
"type": "string"
94619531
}
9532+
},
9533+
{
9534+
"description": "Include Credentials in Response\n\nInclude any credential, for example `password` or `oidc`, in the response. When set to `oidc`, This will return\nthe initial OAuth 2.0 Access Token, OAuth 2.0 Refresh Token and the OpenID Connect ID Token if available.",
9535+
"in": "query",
9536+
"name": "include_credential",
9537+
"schema": {
9538+
"items": {
9539+
"type": "string"
9540+
},
9541+
"type": "array"
9542+
}
94629543
}
94639544
],
94649545
"responses": {
@@ -15327,6 +15408,14 @@
1532715408
"schema": {
1532815409
"type": "string"
1532915410
}
15411+
},
15412+
{
15413+
"description": "Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows.",
15414+
"in": "query",
15415+
"name": "via",
15416+
"schema": {
15417+
"type": "string"
15418+
}
1533015419
}
1533115420
],
1533215421
"responses": {

0 commit comments

Comments
 (0)