Skip to content

Commit

Permalink
docs: bump to 165cc076379abfc37f155e74b1cb096a94390e2b
Browse files Browse the repository at this point in the history
  • Loading branch information
@aeneasr
aeneasr committed Feb 26, 2024
1 parent f7117fc commit 153531a
Showing 1 changed file with 117 additions and 28 deletions.
145 changes: 117 additions & 28 deletions docs/reference/api.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3012,34 +3012,6 @@
"required": ["project_id"],
"type": "object"
},
"internalProvisionMockSubscription": {
"description": "Internal Provision Mock Subscription Request Body",
"properties": {
"currency": {
"description": "Currency\nusd USD\neur Euro",
"enum": ["usd", "eur"],
"type": "string",
"x-go-enum-desc": "usd USD\neur Euro"
},
"identity_id": {
"description": "Identity ID",
"format": "uuid",
"type": "string"
},
"interval": {
"description": "Billing Interval\nmonthly Monthly\nyearly Yearly",
"enum": ["monthly", "yearly"],
"type": "string",
"x-go-enum-desc": "monthly Monthly\nyearly Yearly"
},
"plan": {
"description": "Plan ID",
"type": "string"
}
},
"required": ["plan", "interval", "identity_id", "currency"],
"type": "object"
},
"introspectedOAuth2Token": {
"description": "Introspection contains an access token's session data as specified by\n[IETF RFC 7662](https://tools.ietf.org/html/rfc7662)",
"properties": {
Expand Down Expand Up @@ -3372,6 +3344,10 @@
"state": {
"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."
},
"transient_payload": {
"description": "TransientPayload is used to pass data from the login to hooks and email templates",
"type": "object"
},
"type": {
"$ref": "#/components/schemas/selfServiceFlowType"
},
Expand Down Expand Up @@ -5783,6 +5759,18 @@
"description": "Get Permissions on Project Request Parameters",
"type": "object"
},
"permissionsOnWorkpaceResponse": {
"description": "Get Permissions on Project Request Parameters",
"properties": {
"permissions": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"type": "object"
},
"plans": {
"$ref": "#/components/schemas/Pricing"
},
Expand Down Expand Up @@ -6586,6 +6574,10 @@
"state": {
"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."
},
"transient_payload": {
"description": "TransientPayload is used to pass data from the recovery flow to hooks and email templates",
"type": "object"
},
"type": {
"$ref": "#/components/schemas/selfServiceFlowType"
},
Expand Down Expand Up @@ -7176,6 +7168,10 @@
"state": {
"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."
},
"transient_payload": {
"description": "TransientPayload is used to pass data from the settings flow to hooks and email templates",
"type": "object"
},
"type": {
"$ref": "#/components/schemas/selfServiceFlowType"
},
Expand Down Expand Up @@ -7955,6 +7951,10 @@
"resend": {
"description": "Resend is set when the user wants to resend the code",
"type": "string"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
}
},
"required": ["method", "csrf_token"],
Expand Down Expand Up @@ -8006,6 +8006,10 @@
"description": "The identity traits. This is a placeholder for the registration flow.",
"type": "object"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
},
"upstream_parameters": {
"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`.",
"type": "object"
Expand Down Expand Up @@ -8036,6 +8040,10 @@
"password_identifier": {
"description": "Identifier is the email or username of the user trying to log in.\nThis field is deprecated!",
"type": "string"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
}
},
"required": ["method", "password", "identifier"],
Expand All @@ -8055,6 +8063,10 @@
"totp_code": {
"description": "The TOTP code.",
"type": "string"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
}
},
"required": ["method", "totp_code"],
Expand All @@ -8075,6 +8087,10 @@
"description": "Method should be set to \"webAuthn\" when logging in using the WebAuthn strategy.",
"type": "string"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
},
"webauthn_login": {
"description": "Login a WebAuthn Security Key\n\nThis must contain the ID of the WebAuthN connection.",
"type": "string"
Expand Down Expand Up @@ -8121,6 +8137,10 @@
"enum": ["link", "code"],
"type": "string",
"x-go-enum-desc": "link RecoveryStrategyLink\ncode RecoveryStrategyCode"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
}
},
"required": ["method"],
Expand All @@ -8142,6 +8162,10 @@
"enum": ["link", "code"],
"type": "string",
"x-go-enum-desc": "link RecoveryStrategyLink\ncode RecoveryStrategyCode"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
}
},
"required": ["email", "method"],
Expand Down Expand Up @@ -8364,6 +8388,10 @@
"method": {
"description": "Method\n\nShould be set to \"lookup\" when trying to add, update, or remove a lookup pairing.",
"type": "string"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
}
},
"required": ["method"],
Expand All @@ -8388,6 +8416,10 @@
"description": "The identity's traits\n\nin: body",
"type": "object"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
},
"unlink": {
"description": "Unlink this provider\n\nEither this or `link` must be set.\n\ntype: string\nin: body",
"type": "string"
Expand All @@ -8414,6 +8446,10 @@
"password": {
"description": "Password is the updated password",
"type": "string"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
}
},
"required": ["password", "method"],
Expand All @@ -8433,6 +8469,10 @@
"traits": {
"description": "Traits\n\nThe identity's traits.",
"type": "object"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
}
},
"required": ["traits", "method"],
Expand All @@ -8456,6 +8496,10 @@
"totp_unlink": {
"description": "UnlinkTOTP if true will remove the TOTP pairing,\neffectively removing the credential. This can be used\nto set up a new TOTP device.",
"type": "boolean"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
}
},
"required": ["method"],
Expand All @@ -8472,6 +8516,10 @@
"description": "Method\n\nShould be set to \"webauthn\" when trying to add, update, or remove a webAuthn pairing.",
"type": "string"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
},
"webauthn_register": {
"description": "Register a WebAuthn Security Key\n\nIt is expected that the JSON returned by the WebAuthn registration process\nis included here.",
"type": "string"
Expand Down Expand Up @@ -8543,6 +8591,10 @@
"enum": ["link", "code"],
"type": "string",
"x-go-enum-desc": "link VerificationStrategyLink\ncode VerificationStrategyCode"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
}
},
"required": ["method"],
Expand All @@ -8564,11 +8616,25 @@
"enum": ["link", "code"],
"type": "string",
"x-go-enum-desc": "link VerificationStrategyLink\ncode VerificationStrategyCode"
},
"transient_payload": {
"description": "Transient data to pass along to any webhooks",
"type": "object"
}
},
"required": ["email", "method"],
"type": "object"
},
"updateWorkspacePayload": {
"properties": {
"name": {
"description": "The name of the workspace.",
"type": "string"
}
},
"required": ["name"],
"type": "object"
},
"verifiableCredentialPrimingResponse": {
"properties": {
"c_nonce": {
Expand Down Expand Up @@ -8691,6 +8757,10 @@
"state": {
"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."
},
"transient_payload": {
"description": "TransientPayload is used to pass data from the verification flow to hooks and email templates",
"type": "object"
},
"type": {
"$ref": "#/components/schemas/selfServiceFlowType"
},
Expand Down Expand Up @@ -9459,6 +9529,17 @@
"schema": {
"type": "string"
}
},
{
"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.",
"in": "query",
"name": "include_credential",
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
}
],
"responses": {
Expand Down Expand Up @@ -15327,6 +15408,14 @@
"schema": {
"type": "string"
}
},
{
"description": "Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows.",
"in": "query",
"name": "via",
"schema": {
"type": "string"
}
}
],
"responses": {
Expand Down

0 comments on commit 153531a

Please sign in to comment.