Skip to content

Commit 9f40751

Browse files
aeneasraeneasr
committed
docs: bump to f65bc9c3ec88c424a4ea4978687dbe3fe8e6d294
1 parent ceceb67 commit 9f40751

File tree

1 file changed

+64
-52
lines changed

1 file changed

+64
-52
lines changed

‎docs/reference/api.json‎

Lines changed: 64 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -794,6 +794,9 @@
794794
"hydra_secrets_cookie": {
795795
"$ref": "#/components/schemas/StringSliceJSONFormat"
796796
},
797+
"hydra_secrets_pagination": {
798+
"$ref": "#/components/schemas/StringSliceJSONFormat"
799+
},
797800
"hydra_secrets_system": {
798801
"$ref": "#/components/schemas/StringSliceJSONFormat"
799802
},
@@ -931,6 +934,9 @@
931934
"keto_namespaces": {
932935
"$ref": "#/components/schemas/KetoNamespaces"
933936
},
937+
"keto_secrets_pagination": {
938+
"$ref": "#/components/schemas/StringSliceJSONFormat"
939+
},
934940
"kratos_cookies_same_site": {
935941
"description": "Configures the Ory Kratos Cookie SameSite Attribute\n\nThis governs the \"cookies.same_site\" setting.",
936942
"type": "string"
@@ -4774,6 +4780,36 @@
47744780
},
47754781
"type": "object"
47764782
},
4783+
"keysetPaginationRequestParameters": {
4784+
"description": "The `Link` HTTP header contains multiple links (`first`, `next`) formatted as:\n`\u003chttps://{project-slug}.projects.oryapis.com/admin/sessions?page_size=250\u0026page_token=\u003e; rel=\"first\"`\n\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).",
4785+
"properties": {
4786+
"page_size": {
4787+
"default": 250,
4788+
"description": "Items per Page\n\nThis is the number of items per page to return.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).",
4789+
"format": "int64",
4790+
"maximum": 1000,
4791+
"minimum": 1,
4792+
"type": "integer"
4793+
},
4794+
"page_token": {
4795+
"description": "Next Page Token\n\nThe next page token.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).",
4796+
"type": "string"
4797+
}
4798+
},
4799+
"title": "Pagination Request Parameters",
4800+
"type": "object"
4801+
},
4802+
"keysetPaginationResponseHeaders": {
4803+
"description": "The `Link` HTTP header contains multiple links (`first`, `next`) formatted as:\n`\u003chttps://{project-slug}.projects.oryapis.com/admin/sessions?page_size=250\u0026page_token=\u003e; rel=\"first\"`\n\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).",
4804+
"properties": {
4805+
"link": {
4806+
"description": "The Link HTTP Header\n\nThe `Link` header contains a comma-delimited list of links to the following pages:\n\nfirst: The first page of results.\nnext: The next page of results.\n\nPages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted. Examples:\n\n\u003c/admin/sessions?page_size=250\u0026page_token={last_item_uuid}; rel=\"first\",/admin/sessions?page_size=250\u0026page_token=\u003e; rel=\"next\"",
4807+
"type": "string"
4808+
}
4809+
},
4810+
"title": "Pagination Response Header",
4811+
"type": "object"
4812+
},
47774813
"listCustomDomains": {
47784814
"description": "Custom Hostname List",
47794815
"items": {
@@ -5487,6 +5523,9 @@
54875523
"hydra_secrets_cookie": {
54885524
"$ref": "#/components/schemas/StringSliceJSONFormat"
54895525
},
5526+
"hydra_secrets_pagination": {
5527+
"$ref": "#/components/schemas/StringSliceJSONFormat"
5528+
},
54905529
"hydra_secrets_system": {
54915530
"$ref": "#/components/schemas/StringSliceJSONFormat"
54925531
},
@@ -5624,6 +5663,9 @@
56245663
"keto_namespaces": {
56255664
"$ref": "#/components/schemas/KetoNamespaces"
56265665
},
5666+
"keto_secrets_pagination": {
5667+
"$ref": "#/components/schemas/StringSliceJSONFormat"
5668+
},
56275669
"kratos_cookies_same_site": {
56285670
"description": "Configures the Ory Kratos Cookie SameSite Attribute\n\nThis governs the \"cookies.same_site\" setting.",
56295671
"type": "string"
@@ -7684,38 +7726,6 @@
76847726
},
76857727
"type": "array"
76867728
},
7687-
"pagination": {
7688-
"properties": {
7689-
"page_size": {
7690-
"default": 250,
7691-
"description": "Items per page\n\nThis is the number of items per page to return.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).",
7692-
"format": "int64",
7693-
"maximum": 1000,
7694-
"minimum": 1,
7695-
"type": "integer"
7696-
},
7697-
"page_token": {
7698-
"default": "1",
7699-
"description": "Next Page Token\n\nThe next page token.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).",
7700-
"minimum": 1,
7701-
"type": "string"
7702-
}
7703-
},
7704-
"type": "object"
7705-
},
7706-
"paginationHeaders": {
7707-
"properties": {
7708-
"link": {
7709-
"description": "The link header contains pagination links.\n\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).\n\nin: header",
7710-
"type": "string"
7711-
},
7712-
"x-total-count": {
7713-
"description": "The total number of clients.\n\nin: header",
7714-
"type": "string"
7715-
}
7716-
},
7717-
"type": "object"
7718-
},
77197729
"patchIdentitiesBody": {
77207730
"description": "Patch Identities Body",
77217731
"properties": {
@@ -9770,7 +9780,7 @@
97709780
},
97719781
"node_type": {
97729782
"description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"a\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division",
9773-
"enum": ["text", "input", "img", "a", "script", "div"],
9783+
"enum": ["a"],
97749784
"type": "string",
97759785
"x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division"
97769786
},
@@ -9820,7 +9830,7 @@
98209830
"description": "Division sections are used for interactive widgets that require a hook in the DOM / view.",
98219831
"properties": {
98229832
"class": {
9823-
"description": "The script MIME type",
9833+
"description": "A classname that should be rendered into the DOM.",
98249834
"type": "string"
98259835
},
98269836
"data": {
@@ -9835,8 +9845,8 @@
98359845
"type": "string"
98369846
},
98379847
"node_type": {
9838-
"description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division",
9839-
"enum": ["text", "input", "img", "a", "script", "div"],
9848+
"description": "NodeType represents this node's type. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division",
9849+
"enum": ["div"],
98409850
"type": "string",
98419851
"x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division"
98429852
}
@@ -9858,7 +9868,7 @@
98589868
},
98599869
"node_type": {
98609870
"description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"img\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division",
9861-
"enum": ["text", "input", "img", "a", "script", "div"],
9871+
"enum": ["img"],
98629872
"type": "string",
98639873
"x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division"
98649874
},
@@ -9911,7 +9921,7 @@
99119921
},
99129922
"node_type": {
99139923
"description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"input\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division",
9914-
"enum": ["text", "input", "img", "a", "script", "div"],
9924+
"enum": ["input"],
99159925
"type": "string",
99169926
"x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division"
99179927
},
@@ -10014,7 +10024,7 @@
1001410024
},
1001510025
"node_type": {
1001610026
"description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"script\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division",
10017-
"enum": ["text", "input", "img", "a", "script", "div"],
10027+
"enum": ["script"],
1001810028
"type": "string",
1001910029
"x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division"
1002010030
},
@@ -10057,7 +10067,7 @@
1005710067
},
1005810068
"node_type": {
1005910069
"description": "NodeType represents this node's types. It is a mirror of `node.type` and\nis primarily used to allow compatibility with OpenAPI 3.0. In this struct it technically always is \"text\".\ntext Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division",
10060-
"enum": ["text", "input", "img", "a", "script", "div"],
10070+
"enum": ["text"],
1006110071
"type": "string",
1006210072
"x-go-enum-desc": "text Text\ninput Input\nimg Image\na Anchor\nscript Script\ndiv Division"
1006310073
},
@@ -11542,7 +11552,7 @@
1154211552
"schema": {
1154311553
"default": 250,
1154411554
"format": "int64",
11545-
"maximum": 500,
11555+
"maximum": 1000,
1154611556
"minimum": 1,
1154711557
"type": "integer"
1154811558
}
@@ -11552,8 +11562,6 @@
1155211562
"in": "query",
1155311563
"name": "page_token",
1155411564
"schema": {
11555-
"default": "1",
11556-
"minimum": 1,
1155711565
"type": "string"
1155811566
}
1155911567
},
@@ -12132,7 +12140,7 @@
1213212140
"tags": ["identity"]
1213312141
},
1213412142
"patch": {
12135-
"description": "Creates multiple\n[identities](https://www.ory.sh/docs/kratos/concepts/identity-user-model).\nThis endpoint can also be used to [import\ncredentials](https://www.ory.sh/docs/kratos/manage-identities/import-user-accounts-identities)\nfor instance passwords, social sign in configurations or multi-factor authentications methods.\n\nYou can import up to 1000 identities per request or up to 200 identities with a plaintext password per request.",
12143+
"description": "Creates multiple [identities](https://www.ory.sh/docs/kratos/concepts/identity-user-model).\n\nYou can also use this endpoint to [import credentials](https://www.ory.sh/docs/kratos/manage-identities/import-user-accounts-identities),\nincluding passwords, social sign-in settings, and multi-factor authentication methods.\n\nYou can import:\nUp to 1,000 identities per request\nUp to 200 identities per request if including plaintext passwords\n\nAvoid importing large batches with plaintext passwords. They can cause timeouts as the passwords need to be hashed before they are stored.\n\nIf at least one identity is imported successfully, the response status is 200 OK.\nIf all imports fail, the response is one of the following 4xx errors:\n400 Bad Request: The request payload is invalid or improperly formatted.\n409 Conflict: Duplicate identities or conflicting data were detected.\n\nIf you get a 504 Gateway Timeout:\nReduce the batch size\nAvoid duplicate identities\nPre-hash passwords with BCrypt\n\nIf the issue persists, contact support.",
1213612144
"operationId": "batchPatchIdentities",
1213712145
"requestBody": {
1213812146
"content": {
@@ -12260,7 +12268,7 @@
1226012268
},
1226112269
"/admin/identities/{id}": {
1226212270
"delete": {
12263-
"description": "Calling this endpoint irrecoverably and permanently deletes the [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) given its ID. This action can not be undone.\nThis endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is\nassumed that is has been deleted already.",
12271+
"description": "Calling this endpoint irrecoverably and permanently deletes the [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) given its ID. This action can not be undone.\nThis endpoint returns 204 when the identity was deleted or 404 if the identity was not found.",
1226412272
"operationId": "deleteIdentity",
1226512273
"parameters": [
1226612274
{
@@ -12469,7 +12477,7 @@
1246912477
"tags": ["identity"]
1247012478
},
1247112479
"put": {
12472-
"description": "This endpoint updates an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model). The full identity\npayload (except credentials) is expected. It is possible to update the identity's credentials as well.",
12480+
"description": "This endpoint updates an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model). The full identity\npayload, except credentials, is expected. For partial updates, use the [patchIdentity](https://www.ory.sh/docs/reference/api#tag/identity/operation/patchIdentity) operation.\n\nA credential can be provided via the `credentials` field in the request body.\nIf provided, the credentials will be imported and added to the existing credentials of the identity.",
1247312481
"operationId": "updateIdentity",
1247412482
"parameters": [
1247512483
{
@@ -12555,7 +12563,7 @@
1255512563
},
1255612564
"/admin/identities/{id}/credentials/{type}": {
1255712565
"delete": {
12558-
"description": "Delete an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) credential by its type.\nYou cannot delete password or code auth credentials through this API.",
12566+
"description": "Delete an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) credential by its type.\nYou cannot delete passkeys or code auth credentials through this API.",
1255912567
"operationId": "deleteIdentityCredentials",
1256012568
"parameters": [
1256112569
{
@@ -12591,7 +12599,7 @@
1259112599
"x-go-enum-desc": "password CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode"
1259212600
},
1259312601
{
12594-
"description": "Identifier is the identifier of the OIDC credential to delete.\nFind the identifier by calling the `GET /admin/identities/{id}?include_credential=oidc` endpoint.",
12602+
"description": "Identifier is the identifier of the OIDC/SAML credential to delete.\nFind the identifier by calling the `GET /admin/identities/{id}?include_credential={oidc,saml}` endpoint.",
1259512603
"in": "query",
1259612604
"name": "identifier",
1259712605
"schema": {
@@ -14602,19 +14610,23 @@
1460214610
"operationId": "listTrustedOAuth2JwtGrantIssuers",
1460314611
"parameters": [
1460414612
{
14613+
"description": "Items per Page\n\nThis is the number of items per page to return.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).",
1460514614
"in": "query",
14606-
"name": "MaxItems",
14615+
"name": "page_size",
1460714616
"schema": {
14617+
"default": 250,
1460814618
"format": "int64",
14619+
"maximum": 1000,
14620+
"minimum": 1,
1460914621
"type": "integer"
1461014622
}
1461114623
},
1461214624
{
14625+
"description": "Next Page Token\n\nThe next page token.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).",
1461314626
"in": "query",
14614-
"name": "DefaultItems",
14627+
"name": "page_token",
1461514628
"schema": {
14616-
"format": "int64",
14617-
"type": "integer"
14629+
"type": "string"
1461814630
}
1461914631
},
1462014632
{

0 commit comments

Comments
 (0)