{ "opencollection": "1.0.0", "info": { "name": "Ory Hydra api identity API", "version": "1.0" }, "items": [ { "info": { "name": "identity", "type": "folder" }, "items": [ { "info": { "name": "List Identities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/identities", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "Deprecated Items per Page\n\nDEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.\n\nThis is the number of items per page." }, { "name": "page", "value": "", "type": "query", "description": "Deprecated Pagination Page\n\nDEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.\n\nThis value is currently an integer, but it is not sequential. The value is not the page number, but a\nreference. The next page can be any number and some numbers might return an empty list.\n\nFor example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.\nThe first page can be retrieved by omitting this parameter. Following page pointers will be returned in the\n`Link` header." }, { "name": "page_size", "value": "", "type": "query", "description": "Page Size\n\nThis is the number of items per page to return. For details on pagination please head over to the\n[pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination)." }, { "name": "page_token", "value": "", "type": "query", "description": "Next Page Token\n\nThe next page token. For details on pagination please head over to the\n[pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination)." }, { "name": "consistency", "value": "", "type": "query", "description": "Read Consistency Level (preview)\n\nThe read consistency level determines the consistency guarantee for reads:\n\nstrong (slow): The read is guaranteed to return the most recent data committed at the start of the read.\neventual (very fast): The result will return data that is about 4.8 seconds old.\n\nThe default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with\n`ory patch project --replace '/previews/default_read_consistency_level=\"strong\"'`.\n\nSetting the default consistency level to `eventual` may cause regressions in the future as we add consistency\ncontrols to more APIs. Currently, the following APIs will be affected by this setting:\n\n`GET /admin/identities`\n\nThis feature is in preview and only available in Ory Network.\n ConsistencyLevelUnset ConsistencyLevelUnset is the unset / default consistency level.\nstrong ConsistencyLevelStrong ConsistencyLevelStrong is the strong consistency level.\neventual ConsistencyLevelEventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps." }, { "name": "ids", "value": "", "type": "query", "description": "Retrieve multiple identities by their IDs.\n\nThis parameter has the following limitations:\n\nDuplicate or non-existent IDs are ignored.\nThe order of returned IDs may be different from the request.\nThis filter does not support pagination. You must implement your own pagination as the maximum number of items returned by this endpoint may not exceed a certain threshold (currently 500)." }, { "name": "credentials_identifier", "value": "", "type": "query", "description": "CredentialsIdentifier is the identifier (username, email) of the credentials to look up using exact match.\nOnly one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used." }, { "name": "preview_credentials_identifier_similar", "value": "", "type": "query", "description": "This is an EXPERIMENTAL parameter that WILL CHANGE. Do NOT rely on consistent, deterministic behavior.\nTHIS PARAMETER WILL BE REMOVED IN AN UPCOMING RELEASE WITHOUT ANY MIGRATION PATH.\n\nCredentialsIdentifierSimilar is the (partial) identifier (username, email) of the credentials to look up using similarity search.\nOnly one of CredentialsIdentifier and CredentialsIdentifierSimilar can be used." }, { "name": "include_credential", "value": "", "type": "query", "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." }, { "name": "organization_id", "value": "", "type": "query", "description": "List identities that belong to a specific organization." } ] }, "docs": "Lists all [identities](https://www.ory.com/docs/kratos/concepts/identity-user-model) in the system. Note: filters cannot be combined." }, { "info": { "name": "Create an Identity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/identities", "body": { "type": "json", "data": "{}" } }, "docs": "Create an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model). This endpoint can also be used to\n[import credentials](https://www.ory.com/docs/kratos/manage-identities/import-user-accounts-identities)\nfor instance passwords, social sign in configurations, or multifactor methods." }, { "info": { "name": "Create multiple identities", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/admin/identities", "body": { "type": "json", "data": "{}" } }, "docs": "Creates multiple [identities](https://www.ory.com/docs/kratos/concepts/identity-user-model).\n\nYou can also use this endpoint to [import credentials](https://www.ory.com/docs/kratos/manage-identities/import-user-accounts-identities),\nincluding passwords, social sign-in settings, and multi-factor authentication methods.\n\nIf the patch includes hashed passwords you can import up to 1,000 identities per request.\n\nIf the patch includes at least one plaintext password you can import up to 200 identitie" }, { "info": { "name": "Get an Identity by its External ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/identities/by/external/:externalID", "params": [ { "name": "externalID", "value": "", "type": "path", "description": "ExternalID must be set to the ID of identity you want to get" }, { "name": "include_credential", "value": "", "type": "query", "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." } ] }, "docs": "Return an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) by its external ID. You can optionally\ninclude credentials (e.g. social sign in connections) in the response by using the `include_credential` query parameter." }, { "info": { "name": "Get an Identity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/identities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID must be set to the ID of identity you want to get" }, { "name": "include_credential", "value": "", "type": "query", "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." } ] }, "docs": "Return an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) by its ID. You can optionally\ninclude credentials (e.g. social sign in connections) in the response by using the `include_credential` query parameter." }, { "info": { "name": "Update an Identity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/identities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID must be set to the ID of identity you want to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint updates an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model). The full identity\npayload (except credentials) is expected.\n\nIt is possible to update the identity's credentials as well. Using this operation, credentials will not be overwritten\nbut instead added to the list. For example, if a user has a social sign in connection set up, updating the credentials\nwill keep the social sign in connection and add the new credentials to the list. This prevents acciden" }, { "info": { "name": "Patch an Identity", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/admin/identities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID must be set to the ID of identity you want to update" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially updates an [identity's](https://www.ory.com/docs/kratos/concepts/identity-user-model) field using [JSON Patch](https://jsonpatch.com/).\nThe fields `id`, `stateChangedAt` and `credentials` can not be updated using this method." }, { "info": { "name": "Delete an Identity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/identities/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID is the identity's ID." } ] }, "docs": "Calling this endpoint irrecoverably and permanently deletes the [identity](https://www.ory.com/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." }, { "info": { "name": "Delete a credential for a specific identity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/identities/:id/credentials/:type", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID is the identity's ID." }, { "name": "type", "value": "", "type": "path", "description": "Type is the type of credentials to delete.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\npasskey CredentialsTypePasskey\nprofile CredentialsTypeProfile\nsaml CredentialsTypeSAML\ndeviceauthn CredentialsTypeDeviceAuthn\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" }, { "name": "identifier", "value": "", "type": "query", "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." } ] }, "docs": "Delete an [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) credential by its type.\nYou cannot delete passkeys or code auth credentials through this API." }, { "info": { "name": "List an Identity's Sessions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/identities/:id/sessions", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "Deprecated Items per Page\n\nDEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.\n\nThis is the number of items per page." }, { "name": "page", "value": "", "type": "query", "description": "Deprecated Pagination Page\n\nDEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.\n\nThis value is currently an integer, but it is not sequential. The value is not the page number, but a\nreference. The next page can be any number and some numbers might return an empty list.\n\nFor example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.\nThe first page can be retrieved by omitting this parameter. Following page pointers will be returned in the\n`Link` header." }, { "name": "page_size", "value": "", "type": "query", "description": "Page Size\n\nThis is the number of items per page to return. For details on pagination please head over to the\n[pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination)." }, { "name": "page_token", "value": "", "type": "query", "description": "Next Page Token\n\nThe next page token. For details on pagination please head over to the\n[pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination)." }, { "name": "id", "value": "", "type": "path", "description": "ID is the identity's ID." }, { "name": "active", "value": "", "type": "query", "description": "Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned." } ] }, "docs": "This endpoint returns all sessions that belong to the given Identity." }, { "info": { "name": "Delete & Invalidate an Identity's Sessions", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/identities/:id/sessions", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID is the identity's ID." } ] }, "docs": "Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity." }, { "info": { "name": "Create a Recovery Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/recovery/code", "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates a recovery code which should be given to the user in order for them to recover\n(or activate) their account." }, { "info": { "name": "Create a Recovery Link", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/recovery/link", "params": [ { "name": "return_to", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint creates a recovery link which should be given to the user in order for them to recover\n(or activate) their account." }, { "info": { "name": "List All Sessions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/sessions", "params": [ { "name": "page_size", "value": "", "type": "query", "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.com/docs/ecosystem/api-design#pagination)." }, { "name": "page_token", "value": "", "type": "query", "description": "Next Page Token\n\nThe next page token.\nFor details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination)." }, { "name": "active", "value": "", "type": "query", "description": "Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned." }, { "name": "expand", "value": "", "type": "query", "description": "ExpandOptions is a query parameter encoded list of all properties that must be expanded in the Session.\nIf no value is provided, the expandable properties are skipped." } ] }, "docs": "Listing all sessions that exist." }, { "info": { "name": "Get Session", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/sessions/:id", "params": [ { "name": "expand", "value": "", "type": "query", "description": "ExpandOptions is a query parameter encoded list of all properties that must be expanded in the Session.\nExample - ?expand=Identity&expand=Devices\nIf no value is provided, the expandable properties are skipped." }, { "name": "id", "value": "", "type": "path", "description": "ID is the session's ID." } ] }, "docs": "This endpoint is useful for:\n\nGetting a session object with all specified expandables that exist in an administrative context." }, { "info": { "name": "Deactivate a Session", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/sessions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID is the session's ID." } ] }, "docs": "Calling this endpoint deactivates the specified session. Session data is not deleted." }, { "info": { "name": "Extend a Session", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/admin/sessions/:id/extend", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID is the session's ID." } ] }, "docs": "Calling this endpoint extends the given session ID. If `session.earliest_possible_extend` is set it\nwill only extend the session after the specified time has passed.\n\nThis endpoint returns per default a 204 No Content response on success. Older Ory Network projects may\nreturn a 200 OK response with the session in the body. Returning the session as part of the response\nwill be deprecated in the future and should not be relied upon.\n\nThis endpoint ignores consecutive requests to extend the same se" }, { "info": { "name": "Get all Identity Schemas", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/schemas", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "Deprecated Items per Page\n\nDEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.\n\nThis is the number of items per page." }, { "name": "page", "value": "", "type": "query", "description": "Deprecated Pagination Page\n\nDEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.\n\nThis value is currently an integer, but it is not sequential. The value is not the page number, but a\nreference. The next page can be any number and some numbers might return an empty list.\n\nFor example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.\nThe first page can be retrieved by omitting this parameter. Following page pointers will be returned in the\n`Link` header." }, { "name": "page_size", "value": "", "type": "query", "description": "Page Size\n\nThis is the number of items per page to return. For details on pagination please head over to the\n[pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination)." }, { "name": "page_token", "value": "", "type": "query", "description": "Next Page Token\n\nThe next page token. For details on pagination please head over to the\n[pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination)." } ] }, "docs": "Returns a list of all identity schemas currently in use." }, { "info": { "name": "Get Identity JSON Schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/schemas/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID must be set to the ID of schema you want to get" } ] }, "docs": "Return a specific identity schema." } ] } ], "bundled": true }