The Curator REST API enables you to interact with Curator programmatically. Use this API to build apps, script interactions with Curator, or develop any other type of integration. This page documents the REST resources currently available in Curator API, including the HTTP response codes and example requests and responses.
OpenAPI Specification is an API description format for REST APIs. Curator REST API conforms to OpenAPI 3.0 Specification.
Curator REST OpenAPI specification can be downloaded using the link above and imported into tools such as Postman for testing or Swagger Codegen for SDK code generation.
All API access is accessed from https://[host]/CuratorGateway/api/v1. All data is sent and received as JSON.
Blank fields are included as null instead of being omitted.
All timestamps return in ISO 8601 format and are UTC without timezone information:
YYYY-MM-DDTHH:MM:SSZ
This documentation is for version 1 of the Curator REST API, which is the latest version.
The URIs for resources have the following structure:
https://[host]/CuratorGateway/api/v1/
For example, https://[host]/CuratorGateway/api/v1/assets/00000000000000000000000001162429
You can issue a GET request to the root endpoint to get all the endpoint categories that the Curator REST API v1 supports:
https://[host]/CuratorGateway/api/v1
All resources may have one or more href properties linking to other resources. These are meant to provide explicit URLs so that proper API clients don't need to construct URLs on their own. It is highly recommended that API clients use these. Doing so will make future upgrades of the API easier for developers. All URLs are expected to be proper RFC 6570 URI templates.
Such as:
\n\n{\n \"href\": \"https://[host]/CuratorGateway/api/v1/assets/5be52a09-e43f-4a48-b41b-5c33b95ee53a/metadata/MyMetadataName\",\n \"displayName\": \"My Metadata Name\",\n \"values\": [\n \"My Metadata Value\"\n ],\n \"type\": \"Text\",\n \"name\": {\n \"href\": \"https://[host]/CuratorGateway/api/v1/metadatanames/MyMetadataName\"\n }\n}\n\nThe Curator REST API uses the standard HTTP status codes.
Operations that return an error status code may also return a response body containing details of the error or errors. The schema for each response code can be found under each API request.
When interaction with the Curator API, your application will access Curator on behalf of your users.
Curator API uses OAuth 2.0, an open specification, to authorise access to a user's data and Curator API resources. The primary goal of OAuth is to allow developers to interact with Curator API without requiring them to store sensitive credentials.
Curator API supports common OAuth 2.0 scenarios such as those for web server, client-side, installed, and limited-input device applications.
Once complete, the OAuth flow returns an access token to your client application. This access token should be added to all Curator API requests in the Authorization HTTP header in this format Bearer [access token].
In order for your application to request an access token on behalf of a user, you must first register it with Curator. This can be done via the Curator Gateway admin console (Authentication -> Clients).
Once you have registered your client application you will be issued a client_id.
When you add your client application you will be asked which API Resources scopes that you client application needs access to. The selected scopes are applied to your access token and determine which API calls your application is allowed to execute. Each Curator API request below documents which API Resoure scopes are required.
Below is a list of example API resource scopes:
Curator.Server.API
Curator.Gateway.API
Curator.ProcessEngine.API
See the Authentication section below for a complete list of supported API resource scopes.
In OAuth 2.0, the term “grant type” refers to the way an application gets an access token. OAuth 2.0 defines several grant types which Curator supports.
The Authorization Code is the recommended OAuth grant type for all applications. When you register your client application you can specifiy the supported grant types.
At a high level, the Authorisation Code flow has the following steps:
The client application makes a request to the authorize endpoint.
Curator redirects the user to the login screen.
The user is redirected back to the client application with an authorisation code in the query string.
The client application exchanges the authorisation code for an access token using the token endpoint.
To request an access token using the authorisation code grant type.
1. Make a GET request to the authorize endpoint.
https://[host]/CuratorGateway/connect/authorize?client_id=0a677a41c5f7491d949c9eb4b1098ab0&redirect_uri=https://myapp.com&response_type=code&grant_type=authorization_code&scope=Curator.Server.API Curator.Gateway.API\n\nresponse_type=code - This tells the Curator that the application is initiating the authorisation code flow.
client_id - Your client application id.
redirect_uri - Tells the Curator where to send the user back to after they approve the request.
scope - One or more space-separated strings indicating which permissions the application is requesting. See the authentication section below for a complete list of API resource scopes.
2. The user will then be redirected to the Curator login screen and asked if they would like to authorise your client application.
3. If the user approves the authorisation request, Curator will redirect back to the redirect_uri specified in step 1., adding code to the query string.
https://myapp.com?code=CDD37395D64516E883615AD8862862585A5765C07E890E1022B708A43C2C04F7\n\n4. The code can now be exchanged for an access token using the token endpoint.
The client application makes a POST request to the Curator's token endpoint with the following parameters:
grant_type=authorization_code - This tells the Curator that the application is using the authorisation code flow.
code - The application includes the authorisation code it was given in the redirect.
redirect_uri - The same redirect URI that was used when requesting the code.
client_id - The application’s client ID.
client_secret - The application’s client secret. This should be the same as the client_id.
The response will include the access_token which can then be used to make Curator API requests.
{\n \"access_token\": \"A52CF2278F7749B914102FA39C8D6A1834C676EBA2D86AE7710A816FDA9E4D11\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\",\n \"scope\": \"Curator.Server.API Curator.Gateway.API\"\n}\n\nCan I use the simpler 'resource owner password' grant type?
The 'OAuth 2.0 Security Best Current Practice' disallows the password grant entirely. This
grant type insecurely exposes the credentials of the user
to the client. Even if the client is benign, this results in an
increased attack surface (credentials can leak in more places than
just the Curator Gateway) and users are trained to enter their credentials in
places other than the Curator Gateway.
Also, features such as multi-factor authentication, single sign-on and federation are not possible.
What about the 'client credentials' server-to-server grant type?
All Curator API requests require a users identity to be included in the access token
so that Curator can evaluate the acting users permissions. The process for obtaining access tokens on-behalf of a user
is described above. Although supported by Curator Gateway, grant types like 'client credentials' should not be used.
The Curartor REST API uses pagination to improve performance. Pagination is enforced for operations that could return a large collection of resources.
When a request is made for paged resources, offset and limit query string parameters can be used to define the position and size of the resultset, such as:
https://[host]/CuratorGateway/api/v1/users?offset=5&limit=10
When you make a request to a paginated resource, the response wraps the returned array of values in a JSON object with paging metadata.
offset - The offset into the list of items.
limit - The limit/size of items requested.
size - The total number of resources.
next - The link relation for the immediate next page of results.
last - The link relation for the last page of results.
first - The link relation for the first page of results.
previous - The link relation for the immediate previous page of results.
{\n \"href\": \"https://[host]/CuratorGateway/api/v1/users?offset=5&limit=10\",\n \"rel\": [\n \"collection\"\n ],\n \"offset\": 5,\n \"limit\": 10,\n \"size\": 23,\n \"first\": {\n \"href\": \"https://[host]/CuratorGateway/api/v1/users?offset=5&limit=10\",\n \"rel\": [\n \"collection\"\n ]\n },\n \"previous\": {\n \"href\": \"https://[host]/CuratorGateway/api/v1/users?offset=5&limit=10\",\n \"rel\": [\n \"collection\"\n ]\n },\n \"next\": {\n \"href\": \"https://[host]/CuratorGateway/api/v1/users?offset=15&limit=10\",\n \"rel\": [\n \"collection\"\n ]\n },\n \"last\": {\n \"href\": \"https://[host]/CuratorGateway/api/v1/users?offset=20&limit=10\",\n \"rel\": [\n \"collection\"\n ]\n },\n \"value\": [\n ...\n ]\n}\n\nSome Curator REST API operations may trigger long-running or computationally expensive tasks. In these cases, the operation will schedule an asynchronous task and return a 302 response, indicating the location of the queued task in the Location header. You can query the task by making requests to Get Task for progress updates.
When the task finishes, the response object will contain the results field. The content of the field is specific to the operation that created the task.
Note that asynchronous tasks are not guaranteed to be run in order. In other words, if you need your tasks to execute in a certain order, you should start a task only after the prerequisite task(s) have finished.
If further information is required, please contact us via our Support Portal or visit the Documentation Hub.
\n\nContact Support:
Name: IPV
Email: support@ipv.com
Gets a list of asset activity with searching/filtering.
\n","urlObject":{"path":["api","v1","assets","activity"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"An optional list of asset ids to get activity for.
\n","type":"text/plain"},"key":"assetIds","value":"urn:uuid:9cfdd12c-aecf-e4bd-a9af-888f36747cf0"},{"description":{"content":"An optional list of asset ids to get activity for.
\n","type":"text/plain"},"key":"assetIds","value":"urn:uuid:2a2cfe5c-0572-d239-e903-5a35817c07ad"},{"description":{"content":"An optional list of user ids to get activity for.
\n","type":"text/plain"},"key":"userIds","value":"urn:uuid:9cfdd12c-aecf-e4bd-a9af-888f36747cf0"},{"description":{"content":"An optional list of user ids to get activity for.
\n","type":"text/plain"},"key":"userIds","value":"urn:uuid:2a2cfe5c-0572-d239-e903-5a35817c07ad"},{"description":{"content":"A value indicating whether to enable grouping for this type.
\n","type":"text/plain"},"key":"groupByAsset.enabled","value":"true"},{"description":{"content":"The optional offset into the list of items. Must be greater than or equal to 0.
\n","type":"text/plain"},"key":"groupByAsset.offset","value":"1"},{"description":{"content":"The number of items to return. Limit must be greater than or equal to 0 and less than 200.
\n","type":"text/plain"},"key":"groupByAsset.limit","value":"50"},{"description":{"content":"An optional list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"cupidatat fugiat Excepteur"},{"description":{"content":"An optional list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"reprehenderit ut proident"},{"description":{"content":"An optional list of clients ids to get activity for.
\n","type":"text/plain"},"key":"clientIds","value":"urn:uuid:9cfdd12c-aecf-e4bd-a9af-888f36747cf0"},{"description":{"content":"An optional list of clients ids to get activity for.
\n","type":"text/plain"},"key":"clientIds","value":"urn:uuid:2a2cfe5c-0572-d239-e903-5a35817c07ad"},{"description":{"content":"An optional list of activity types to return.
\n","type":"text/plain"},"key":"types","value":"cupidatat fugiat Excepteur"},{"description":{"content":"An optional list of activity types to return.
\n","type":"text/plain"},"key":"types","value":"reprehenderit ut proident"},{"description":{"content":"The optional offset into the list of items. Must be greater than or equal to 0.
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"The number of items to return. Limit must be greater than or equal to 0 and less than 200.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"0c88207f-a8e7-43b1-a8b9-324a000eae2c","name":"The list of asset activity is returned.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns the details of a single asset activity.\n The activity is identified by its ID. If a matching activity is found its details are returned.
\n","urlObject":{"path":["api","v1","assets","activity",":activityId"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"02fb2dbf-240e-467d-b534-f3fa3c23d286","description":{"content":"(Required) The id of the activity to get.
\n","type":"text/plain"},"type":"any","value":"10","key":"activityId"}]}},"response":[{"id":"df254411-92c1-476d-b2df-2217b08e1f67","name":"Returned if the request is successful.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns activity details for the specified asset.
\n","urlObject":{"path":["api","v1","assets",":assetId","activity"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"An optional list of user ids to get activity for.
\n","type":"text/plain"},"key":"userIds","value":"urn:uuid:9cfdd12c-aecf-e4bd-a9af-888f36747cf0"},{"description":{"content":"An optional list of user ids to get activity for.
\n","type":"text/plain"},"key":"userIds","value":"urn:uuid:2a2cfe5c-0572-d239-e903-5a35817c07ad"},{"description":{"content":"An optional list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"cupidatat fugiat Excepteur"},{"description":{"content":"An optional list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"reprehenderit ut proident"},{"description":{"content":"An optional list of clients ids to get activity for.
\n","type":"text/plain"},"key":"clientIds","value":"urn:uuid:9cfdd12c-aecf-e4bd-a9af-888f36747cf0"},{"description":{"content":"An optional list of clients ids to get activity for.
\n","type":"text/plain"},"key":"clientIds","value":"urn:uuid:2a2cfe5c-0572-d239-e903-5a35817c07ad"},{"description":{"content":"An optional list of activity types to return.
\n","type":"text/plain"},"key":"types","value":"cupidatat fugiat Excepteur"},{"description":{"content":"An optional list of activity types to return.
\n","type":"text/plain"},"key":"types","value":"reprehenderit ut proident"},{"description":{"content":"The optional offset into the list of items. Must be greater than or equal to 0.
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"The number of items to return. Limit must be greater than or equal to 0 and less than 200.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[{"id":"9e5b327f-fe20-480d-bc14-dd71188b85a1","description":{"content":"(Required) The id of the asset to get activity for.
\n","type":"text/plain"},"type":"any","value":"9c9acd36-cdbf-4689-a764-de845eec74c7","key":"assetId"}]}},"response":[{"id":"c1ca6434-388c-41be-bac9-2aa13b5d378c","name":"Returned if the request is successful.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns the asset thumbnail.\n The asset is identified by its ID. If a matching asset is found and it has a thumbnail a thumbnail image is returned.
\n","urlObject":{"path":["api","v1","assets",":assetId","thumbnail"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"92a8dd64-e8b7-474c-ae8d-e66caa4efc41","description":{"content":"(Required) The id of the asset to get the thumbnail for.
\n","type":"text/plain"},"type":"any","value":"9c9acd36-cdbf-4689-a764-de845eec74c7","key":"assetId"}]}},"response":[{"id":"5f949d79-0fb3-43f5-8781-9dd6c2e749f1","name":"Returned if the request is successful.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Gets a list of assets with basic searching.
\n","urlObject":{"path":["api","v1","assets"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"An optional list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"cupidatat fugiat Excepteur"},{"description":{"content":"An optional list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"reprehenderit ut proident"},{"description":{"content":"An optional list of folder ids to restrict the search to. If not provided, searches are performed from the root folder.
\n","type":"text/plain"},"key":"folderIds","value":"urn:uuid:9cfdd12c-aecf-e4bd-a9af-888f36747cf0"},{"description":{"content":"An optional list of folder ids to restrict the search to. If not provided, searches are performed from the root folder.
\n","type":"text/plain"},"key":"folderIds","value":"urn:uuid:2a2cfe5c-0572-d239-e903-5a35817c07ad"},{"description":{"content":"A value indicating whether to perform a recursive search down the folder tree. The default value is true.
\n","type":"text/plain"},"key":"recursive","value":"true"},{"description":{"content":"An optional list of asset types to return. If not set, all asset types are returned.
\n","type":"text/plain"},"key":"assetTypes","value":"cupidatat fugiat Excepteur"},{"description":{"content":"An optional list of asset types to return. If not set, all asset types are returned.
\n","type":"text/plain"},"key":"assetTypes","value":"reprehenderit ut proident"},{"description":{"content":"An optional list of text queries to filter the results by.\nThe format is [fieldname]:[searchvalue]. If a field is not specified, all fields are searched.
\nAn optional list of text queries to filter the results by.\nThe format is [fieldname]:[searchvalue]. If a field is not specified, all fields are searched.
\nA value indicating whether to logically AND any specified queries. The default behaviour is to OR the queries.
\n","type":"text/plain"},"key":"andQueries","value":"false"},{"description":{"content":"The optional offset into the list of items. Must be greater than or equal to 0.
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"The number of items to return. Limit must be greater than or equal to 0 and less than 200.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"f0967549-c95e-4043-8338-a07c05dd98f6","name":"The list of assets is returned.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns the details for an asset.\n The asset is identified by its ID. If a matching asset is found its details are returned.
\n","urlObject":{"path":["api","v1","assets",":assetId"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"An optional list list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"cupidatat fugiat Excepteur"},{"description":{"content":"An optional list list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"reprehenderit ut proident"}],"variable":[{"id":"b0d6faa3-aa4d-4271-b33c-e6d646b9a1ab","description":{"content":"(Required) The id of the asset to get.
\n","type":"text/plain"},"type":"any","value":"9c9acd36-cdbf-4689-a764-de845eec74c7","key":"assetId"}]}},"response":[{"id":"4de05b7d-2fe6-4a18-bd40-cbf69d007294","name":"Returned if the request is successful.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Used to check if an asset exists with the specified id.
\n","urlObject":{"path":["api","v1","assets",":assetId"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"cacfdc15-a0c6-40fc-a4df-a14b3e363308","description":{"content":"(Required) The asset id to check exists.
\n","type":"text/plain"},"type":"any","value":"9c9acd36-cdbf-4689-a764-de845eec74c7","key":"assetId"}]}},"response":[{"id":"d547e4ca-5f12-4357-b8d4-02919597b0e9","name":"The asset does exist.","originalRequest":{"method":"HEAD","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Used to delete or mark for delete an asset.
\n","urlObject":{"path":["api","v1","assets",":assetId"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"An optional date/time to delay the delete until. The value should be a UTC datetime.
\n","type":"text/plain"},"key":"delayUntil","value":"1989-01-22T04:24:39.897Z"}],"variable":[{"id":"d94dc720-86bf-4ea1-a214-b53ecabe49e5","description":{"content":"(Required) The id of the asset to delete.
\n","type":"text/plain"},"type":"any","value":"9c9acd36-cdbf-4689-a764-de845eec74c7","key":"assetId"}]}},"response":[{"id":"06a7d13f-7a5d-481a-96bc-21f8cd77f927","name":"The asset was deleted or marked for delete successfully.","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Used to undelete an asset that was marked for delete.
\n","urlObject":{"path":["api","v1","assets",":assetId"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"14389040-074e-41d7-9cf7-b14377a3c2c5","description":{"content":"(Required) The id of the asset to undelete.
\n","type":"text/plain"},"type":"any","value":"9c9acd36-cdbf-4689-a764-de845eec74c7","key":"assetId"}]}},"response":[{"id":"33dbfef0-67c0-493e-ab54-e46b9725b671","name":"The asset was undeleted successfully.","originalRequest":{"method":"PATCH","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Gets a list of ancestors for the specified asset. The ancestors are ordered from 'closest' first.
\n","urlObject":{"path":["api","v1","assets",":assetId","ancestors"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"An optional list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"cupidatat fugiat Excepteur"},{"description":{"content":"An optional list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"reprehenderit ut proident"},{"description":{"content":"A value indicating whether to order the ancestors from top down.
\n","type":"text/plain"},"key":"orderTopDown","value":"true"},{"description":{"content":"The optional offset into the list of items. Must be greater than or equal to 0.
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"The number of items to return. Limit must be greater than or equal to 0 and less than 200.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[{"id":"3744268d-8a0b-4bd8-b4a7-c370aabd2ff5","description":{"content":"(Required) The id of the asset to get ancestors for.
\n","type":"text/plain"},"type":"any","value":"9c9acd36-cdbf-4689-a764-de845eec74c7","key":"assetId"}]}},"response":[{"id":"4726be78-d370-4859-87e9-27f59c673df0","name":"The list of asset ancestors is returned.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns an assets metadata.
\n","urlObject":{"path":["api","v1","assets",":assetId","metadata",":name"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"ae1c8f24-aa31-4fd6-bccd-45e9aceec0d8","description":{"content":"(Required) The id of the asset to get metadata for.
\n","type":"text/plain"},"type":"any","value":"9c9acd36-cdbf-4689-a764-de845eec74c7","key":"assetId"},{"id":"a0d693fa-6939-442a-a960-5e9bdbfd67c3","description":{"content":"(Required) The name of metadata to return.
\n","type":"text/plain"},"type":"any","value":"My Metadata Name","key":"name"}]}},"response":[{"id":"c10017e9-221c-4911-9f24-ee4a86872542","name":"The asset metadata.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Sets the value of an asset's metadata. If the metadata name doesn't exist it is created. If the asset metadata does not exist it is added against the asset. If it exists the value is updated.
\n","urlObject":{"path":["api","v1","assets",":assetId","metadata",":name"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"8bf3920e-3f96-4cbe-a7b9-ff9a5f729fd8","description":{"content":"(Required) The id of the asset to set metadata for.
\n","type":"text/plain"},"type":"any","value":"9c9acd36-cdbf-4689-a764-de845eec74c7","key":"assetId"},{"id":"19de8385-a914-4e3a-b6b1-2952fd2214f6","description":{"content":"(Required) The name of metadata to set.
\n","type":"text/plain"},"type":"any","value":"My Metadata Name","key":"name"}]}},"response":[{"id":"8b754ff2-f154-48ee-a74e-ab5a480de45d","name":"Returned if the asset metadata is updated.","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Deletes an assets's metadata.
\n","urlObject":{"path":["api","v1","assets",":assetId","metadata",":name"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"f54da474-a11f-4edf-8735-9ed0a471d96c","description":{"content":"(Required) The id of the asset to delete.
\n","type":"text/plain"},"type":"any","value":"9c9acd36-cdbf-4689-a764-de845eec74c7","key":"assetId"},{"id":"ad342afe-ee78-451b-bf6f-413c0e537b7c","description":{"content":"(Required) The name of metadata to delete.
\n","type":"text/plain"},"type":"any","value":"My Metadata Name","key":"name"}]}},"response":[{"id":"36eeeb6d-1723-4480-8d3e-f9ee2e25d930","name":"The asset metadata was deleted successfully.","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Sets multiple asset metadata values. If the metadata names don't exist they will be created. If the asset metadata does not exist it is added against the asset. If it exists the value is updated.
\n","urlObject":{"path":["api","v1","assets",":assetId","metadata"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"8a2c5c2a-e410-4d87-abc6-08d52551e0ab","description":{"content":"(Required) The id of the asset to set metadata for.
\n","type":"text/plain"},"type":"any","value":"9c9acd36-cdbf-4689-a764-de845eec74c7","key":"assetId"}]}},"response":[{"id":"d4ceed6e-0af7-46d3-97d1-349895a3b2d0","name":"Returned if the asset metadata is updated.","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Creates a new asset from a file.
\n","urlObject":{"path":["api","v1","assets","files"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"d8582cab-7a6f-4ac3-a8ba-db3775c11a2c","name":"The request to create an asset was submitted sucessfully. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Creates a new placeholder asset.
\n","urlObject":{"path":["api","v1","assets","placeholders"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"5fd740b6-ada7-4571-9af6-bc87194a6b4b","name":"The request to create a placeholder asset was submitted sucessfully. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Creates a new production asset.
\n","urlObject":{"path":["api","v1","assets","productions"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"253f1bbf-2fc5-4f94-ac36-6ecc7d2b0a37","name":"The request to create a production asset was submitted sucessfully. Follow the location link in the response to determine the status of the task and use Get task to obtain subsequent updates.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"(Required) The actual file data.
\n","value":null},{"key":"name","value":"My Asset","type":"text","description":"The name to give the asset. If not provided, the filename without extension is used.
\n"},{"key":"folderPath","value":"ad nostrud dolore incididunt esse","type":"text","description":"The full virtual Curator folder path to create the asset in if FolderId is not specified.
\n"},{"key":"folderId","value":"ff984370-388e-467d-6fd9-3910f045d836","type":"text","description":"The Curator folder id to create the asset in if FolderPath is not specified.
\n"},{"key":"metadataNames","value":"[\"quis \",\"ullamco ea culpa\"]","type":"text","description":"Optional list of metadata names to add to the asset.
\n"},{"key":"metadataValues","value":"[\"mollit Ut cupidatat\",\"esse re\"]","type":"text","description":"Optional list of metadata values to add to the asset.
\n"},{"key":"storeId","value":"-45718721","type":"text","description":"An optional store id to force the upload into a specific store.
\n"},{"key":"labels","value":"[\"irure magna\",\"deserunt adipisicing\"]","type":"text","description":"An optional list of labels to attach to the file.
\n"},{"key":"mediaStoreName","value":"nostrud sunt voluptate tempor reprehenderit","type":"text","description":"An optional media store name to use when uploading a file.
\n"}]},"url":"https://dev.ipv.com/CuratorGateway/api/v1/assets/upload","description":"Uploads a file, stores the file and creates an asset from it.
\n","urlObject":{"path":["api","v1","assets","upload"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"46342068-6b56-4bba-9f51-4c9a015fac1a","name":"The file was sucessfully uploaded and asset created. The location header in the response will contain the URI to the asset.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Before uploading a file this request can be used to create a placeholder asset.
\n","urlObject":{"path":["api","v1","assets","upload","placeholder"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"9d1c7dfc-bcfa-46ed-ac3b-913e29e69b18","name":"The placeholder asset created. The location header in the response will contain the URI to the asset.","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns a client.
\n","urlObject":{"path":["api","v1","clients","links",":linkId"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"4268c1d2-9ceb-4f9c-a304-c32ebdb9c707","description":{"content":"(Required) The id of the client link to get.
\n","type":"text/plain"},"type":"any","value":"12","key":"linkId"}]}},"response":[{"id":"09b16f3d-8b49-4d18-bb1f-6032bc1ff274","name":"The client link.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns a list of client applications.
\n","urlObject":{"path":["api","v1","clients"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"The optional offset into the list of items. Must be greater than or equal to 0.
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"The number of items to return. Limit must be greater than or equal to 0 and less than 200.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"b443612c-1e30-4946-b5a8-47caaab36af3","name":"The list of clients is returned.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns a client.
\n","urlObject":{"path":["api","v1","clients",":clientId"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"67918320-4eb6-4c59-be78-a4f7545bb889","description":{"content":"(Required) The id of the client to get.
\n","type":"text/plain"},"type":"any","value":"52e29e3a-62f8-4e02-b88e-fcef2dea5cf4","key":"clientId"}]}},"response":[{"id":"d675420c-c764-4771-b710-ae98e75c4442","name":"The client.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Determines if a client with the given id exists.
\n","urlObject":{"path":["api","v1","clients",":clientId"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"878f2991-c502-4326-9c9b-08ad07eda58c","description":{"content":"(Required) The id of the client to check if exists.
\n","type":"text/plain"},"type":"any","value":"52e29e3a-62f8-4e02-b88e-fcef2dea5cf4","key":"clientId"}]}},"response":[{"id":"31739ef2-8f13-4d5e-adac-a033f770e119","name":"The client exists.","originalRequest":{"method":"HEAD","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns a list of metadata names.
\n","urlObject":{"path":["api","v1","metadatanames"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"The optional offset into the list of items. Must be greater than or equal to 0.
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"The number of items to return. Limit must be greater than or equal to 0 and less than 200.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"e1e89b12-7b69-44e1-b5e7-8f65f16a5e42","name":"The list of metadata names is returned.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Gets a single metadata name by its name.
\n","urlObject":{"path":["api","v1","metadatanames",":name"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"623254cd-7a34-4263-b787-7eacb18f36bd","description":{"content":"(Required) The name of the metadata name to get.
\n","type":"text/plain"},"type":"any","value":"My Metadata Name","key":"name"}]}},"response":[{"id":"f54a2767-1563-438b-98e9-8b384de9c7de","name":"The metadata name.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Used to determine if a metadata name with the specified name exists.
\n","urlObject":{"path":["api","v1","metadatanames",":name"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"dba48f34-8c89-44b8-b95b-10da584610c0","description":{"content":"(Required) The name of the metadata name to get.
\n","type":"text/plain"},"type":"any","value":"My Metadata Name","key":"name"}]}},"response":[{"id":"df6bd85b-034d-4434-ad44-56fa64c9bc56","name":"The metadata name exists.","originalRequest":{"method":"HEAD","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns a list of metadata views.
\n","urlObject":{"path":["api","v1","metadataviews"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"The optional offset into the list of items. Must be greater than or equal to 0.
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"The number of items to return. Limit must be greater than or equal to 0 and less than 200.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"de078423-d5cd-4a41-9788-9337c5fac836","name":"The list of metadata views is returned.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Gets a single metadata view by its name.
\n","urlObject":{"path":["api","v1","metadataviews",":name"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"60c8d0be-2ffd-4d95-9d83-82386cb6ece5","description":{"content":"(Required) The name of the metadata view to get.
\n","type":"text/plain"},"type":"any","value":"My Metadata Name","key":"name"}]}},"response":[{"id":"920cba65-a15e-466b-a20a-b58465cff17e","name":"The metadata view.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Used to determine if a metadata view with the specified name exists.
\n","urlObject":{"path":["api","v1","metadataviews",":name"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"ffc77bd8-5945-4b32-a290-977972f530e6","description":{"content":"(Required) The name of the metadata view to get.
\n","type":"text/plain"},"type":"any","value":"My Metadata Name","key":"name"}]}},"response":[{"id":"e0689dba-98dd-48c7-87ab-709bb4061339","name":"The metadata view exists.","originalRequest":{"method":"HEAD","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns details for the current user as obtained from the specified authorisation token.
\n","urlObject":{"path":["api","v1","myself"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"a657ebb8-fe7d-46a1-881b-1836b7209caf","name":"Returned if the request is successful.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns the current users avatar.
\n","urlObject":{"path":["api","v1","myself","avatar"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"The width of avatar to return. The resized avatar will fit the bounds of the original in order to maintain the aspect ratio. If not provided the original width is used.
\n","type":"text/plain"},"key":"width","value":"200"},{"description":{"content":"The height of avatar to return. The resized avatar will fit the bounds of the original in order to maintain the aspect ratio. If not provided the original height is used.
\n","type":"text/plain"},"key":"height","value":"200"}],"variable":[]}},"response":[{"id":"a0398e1c-0ff5-4d50-9fb4-6ed27584d1b8","name":"Returned if the request is successful.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns a list of clients that the current user is authorised to access based on their permission roles.
\n","urlObject":{"path":["api","v1","myself","clients"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"An optional list of values to filter the results based on their launch path template.\nIf the clients launch path template contains any of the specified values and it is within the paging parameters then it is returned.
\n","type":"text/plain"},"key":"launchPathTemplateFilters","value":"cupidatat fugiat Excepteur"},{"description":{"content":"An optional list of values to filter the results based on their launch path template.\nIf the clients launch path template contains any of the specified values and it is within the paging parameters then it is returned.
\n","type":"text/plain"},"key":"launchPathTemplateFilters","value":"reprehenderit ut proident"},{"description":{"content":"The optional offset into the list of items. Must be greater than or equal to 0.
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"The number of items to return. Limit must be greater than or equal to 0 and less than 200.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"c1716af0-6705-4aca-b6cb-79a87a7ebc6c","name":"The list of clients is returned.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Returns activity details for the current user.
\n","urlObject":{"path":["api","v1","myself","activity"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"An optional list of asset ids to get activity for.
\n","type":"text/plain"},"key":"assetIds","value":"urn:uuid:9cfdd12c-aecf-e4bd-a9af-888f36747cf0"},{"description":{"content":"An optional list of asset ids to get activity for.
\n","type":"text/plain"},"key":"assetIds","value":"urn:uuid:2a2cfe5c-0572-d239-e903-5a35817c07ad"},{"description":{"content":"A value indicating whether to enable grouping for this type.
\n","type":"text/plain"},"key":"groupByAsset.enabled","value":"false"},{"description":{"content":"The optional offset into the list of items. Must be greater than or equal to 0.
\n","type":"text/plain"},"key":"groupByAsset.offset","value":"1"},{"description":{"content":"The number of items to return. Limit must be greater than or equal to 0 and less than 200.
\n","type":"text/plain"},"key":"groupByAsset.limit","value":"50"},{"description":{"content":"An optional list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"cupidatat fugiat Excepteur"},{"description":{"content":"An optional list of metadata names to return. If not set, all metadata is returned.
\n","type":"text/plain"},"key":"names","value":"reprehenderit ut proident"},{"description":{"content":"An optional list of clients ids to get activity for.
\n","type":"text/plain"},"key":"clientIds","value":"urn:uuid:9cfdd12c-aecf-e4bd-a9af-888f36747cf0"},{"description":{"content":"An optional list of clients ids to get activity for.
\n","type":"text/plain"},"key":"clientIds","value":"urn:uuid:2a2cfe5c-0572-d239-e903-5a35817c07ad"},{"description":{"content":"An optional list of activity types to return.
\n","type":"text/plain"},"key":"types","value":"cupidatat fugiat Excepteur"},{"description":{"content":"An optional list of activity types to return.
\n","type":"text/plain"},"key":"types","value":"reprehenderit ut proident"},{"description":{"content":"The optional offset into the list of items. Must be greater than or equal to 0.
\n","type":"text/plain"},"key":"offset","value":"1"},{"description":{"content":"The number of items to return. Limit must be greater than or equal to 0 and less than 200.
\n","type":"text/plain"},"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"3f9a8407-ba69-4e1e-9a38-12caed666ec1","name":"Returned if the request is successful.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"The end session endpoint can be used to trigger single sign-out. To use the end session endpoint a client application will redirect the user’s browser to the end session URL. All applications that the user has logged into via the browser during the user’s session can participate in the sign-out.
\n","urlObject":{"path":["connect","endsession"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"When the user is redirected to the endpoint, they will be prompted if they really want to sign-out. This prompt can be bypassed by a client sending the original id_token received from authentication.
\n","type":"text/plain"},"key":"id_token_hint","value":"consequat dolore"},{"description":{"content":"If a valid id_token_hint is passed, then the client may also send a post_logout_redirect_uri parameter. This can be used to allow the user to redirect back to the client after sign-out.
\n","type":"text/plain"},"key":"post_logout_redirect_uri","value":"consequat dolore"},{"description":{"content":"If a valid post_logout_redirect_uri is passed, then the client may also send a state parameter. This will be returned back to the client as a query string parameter after the user redirects back to the client. This is typically used by clients to round-trip state across the redirect.
\n","type":"text/plain"},"key":"state","value":"consequat dolore"}],"variable":[]}},"response":[{"id":"905a55cc-cb7c-4977-a240-3754793c91ce","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"(Required) The string value of the token. For access tokens, this is the \"access_token\" value returned from the token endpoint. For refresh tokens, this is the \"refresh_token\" value.
\n"}]},"url":"https://dev.ipv.com/CuratorGateway/connect/introspect","description":"This endpoint be used to validate reference tokens (or JWTs if the consumer does not have support for appropriate JWT or cryptographic libraries). The introspection endpoint requires authentication - since the client of an introspection endpoint is an API.
\n","urlObject":{"path":["connect","introspect"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"ccb27e3a-de79-4367-ae0d-a2bdf590f948","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic(Required) The string value of the token to revoke.
\n"},{"key":"token_type_hint","value":"access_token","description":"Either \"access_token\" or \"refresh_token\".
\n"}]},"url":"https://dev.ipv.com/CuratorGateway/connect/revocation","description":"This endpoint allows revoking access tokens (reference tokens only) and refresh token.
\n","urlObject":{"path":["connect","revocation"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"cff46fb5-ce09-41a8-9220-3b57690b88eb","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicThe user info endpoint can be used to retrieve identity information about a user.
\n","urlObject":{"path":["connect","userinfo"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"fd792af8-eabd-4733-9f14-33aa8e158acb","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"The authorize endpoint can be used to request tokens or authorization codes via the browser. This process typically involves authentication of the end-user and optionally consent.
\n","urlObject":{"path":["connect","authorize"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[{"description":{"content":"(Required) Identifier of the client.
\n","type":"text/plain"},"key":"client_id","value":"consequat dolore"},{"description":{"content":"(Required) One or more registered scopes.
\n","type":"text/plain"},"key":"scope","value":"consequat dolore"},{"description":{"content":"(Required) The redirect URIs for the client.
\n","type":"text/plain"},"key":"redirect_uri","value":"consequat dolore"},{"description":{"content":"(Required) The response type: code, ideneity token and/or access token.
\n","type":"text/plain"},"key":"response_type","value":"code id_token"},{"description":{"content":"Sends the token response as a form post instead of a fragment encoded redirect.
\n","type":"text/plain"},"key":"response_mode","value":"form_post"},{"description":{"content":"Instead of providing all parameters as individual query string parameters, you can provide a subset or all of them as a JWT.
\n","type":"text/plain"},"key":"request","value":"consequat dolore"},{"description":{"content":"URL of a pre-packaged JWT containing request parameters
\n","type":"text/plain"},"key":"request_uri","value":"consequat dolore"},{"description":{"content":"The authorisation server will echo back the state value on the token response, this is for round tripping state between client and provider, correlating request and response and CSRF/replay protection. (recommended).
\n","type":"text/plain"},"key":"state","value":"consequat dolore"},{"description":{"content":"The authorisation server will echo back the nonce value in the identity token, this is for replay protection. Required for identity tokens via implicit grant.
\n","type":"text/plain"},"key":"nonce","value":"consequat dolore"},{"description":{"content":"The login UI will be shown or not.
\n","type":"text/plain"},"key":"prompt","value":"login"},{"description":{"content":"Sends the code challenge for PKCE.
\n","type":"text/plain"},"key":"code_challenge","value":"consequat dolore"},{"description":{"content":"Plain indicates that the challenge is using plain text (not recommended) S256 indicates the challenge is hashed with SHA256.
\n","type":"text/plain"},"key":"code_challenge_method","value":"S256"},{"description":{"content":"Can be used to pre-fill the username field on the login page.
\n","type":"text/plain"},"key":"login_hint","value":"consequat dolore"},{"description":{"content":"Gives a hint about the desired display language of the login UI.
\n","type":"text/plain"},"key":"ui_locales","value":"consequat dolore"},{"description":{"content":"If the user’s logon session exceeds the max age (in seconds), the login UI will be shown.
\n","type":"text/plain"},"key":"max_age","value":"consequat dolore"}],"variable":[]}},"response":[{"id":"5bbf71d1-c395-4a8c-b658-6d4963fd9a0b","name":"Redirect","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://dev.ipv.com/CuratorGateway/connect/authorize?client_id=consequat dolore&scope=consequat dolore&redirect_uri=consequat dolore&response_type=code id_token&response_mode=form_post&request=consequat dolore&request_uri=consequat dolore&state=consequat dolore&nonce=consequat dolore&prompt=login&code_challenge=consequat dolore&code_challenge_method=S256&login_hint=consequat dolore&ui_locales=consequat dolore&max_age=consequat dolore","host":["https://dev.ipv.com/CuratorGateway"],"path":["connect","authorize"],"query":[{"key":"client_id","value":"consequat dolore"},{"key":"scope","value":"consequat dolore"},{"key":"redirect_uri","value":"consequat dolore"},{"key":"response_type","value":"code id_token"},{"key":"response_mode","value":"form_post"},{"key":"request","value":"consequat dolore"},{"key":"request_uri","value":"consequat dolore"},{"key":"state","value":"consequat dolore"},{"key":"nonce","value":"consequat dolore"},{"key":"prompt","value":"login"},{"key":"code_challenge","value":"consequat dolore"},{"key":"code_challenge_method","value":"S256"},{"key":"login_hint","value":"consequat dolore"},{"key":"ui_locales","value":"consequat dolore"},{"key":"max_age","value":"consequat dolore"}]}},"status":"Found","code":302,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"96be8398-e96d-41dc-ba5d-0aa3f6f039c9"},{"name":"Request tokens or authorization codes via the browser.","id":"df19ebfe-2096-4270-8443-5bb88efc837c","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"eiusmod commodo nisi dolor veniam","description":"(Required) Identifier of the client.
\n"},{"key":"scope","value":"in mollit","description":"(Required) One or more registered scopes.
\n"},{"key":"redirect_uri","value":"sint incididunt enim aliqua nisi","description":"(Required) The redirect URIs for the client.
\n"},{"key":"response_type","value":"id_token token","description":"(Required) The response type: code, ideneity token and/or access token.
\n"},{"key":"response_mode","value":"form_post","description":"Sends the token response as a form post instead of a fragment encoded redirect.
\n"},{"key":"request","value":"pariatur Excepteur","description":"Instead of providing all parameters as individual query string parameters, you can provide a subset or all of them as a JWT.
\n"},{"key":"request_uri","value":"ex aute velit tempor","description":"URL of a pre-packaged JWT containing request parameters
\n"},{"key":"state","value":"Excepteur","description":"The authorisation server will echo back the state value on the token response, this is for round tripping state between client and provider, correlating request and response and CSRF/replay protection. (recommended).
\n"},{"key":"nonce","value":"dolore ut","description":"The authorisation server will echo back the nonce value in the identity token, this is for replay protection. Required for identity tokens via implicit grant.
\n"},{"key":"prompt","value":"none","description":"The login UI will be shown or not.
\n"},{"key":"code_challenge","value":"officia laboris eiusmod","description":"Sends the code challenge for PKCE.
\n"},{"key":"code_challenge_method","value":"S256","description":"Plain indicates that the challenge is using plain text (not recommended) S256 indicates the challenge is hashed with SHA256.
\n"},{"key":"login_hint","value":"qui sint nisi do","description":"Can be used to pre-fill the username field on the login page.
\n"},{"key":"ui_locales","value":"fugiat co","description":"Gives a hint about the desired display language of the login UI.
\n"},{"key":"max_age","value":"proident ipsum consectetur","description":"If the user’s logon session exceeds the max age (in seconds), the login UI will be shown.
\n"}]},"url":"https://dev.ipv.com/CuratorGateway/connect/authorize","description":"The authorize endpoint can be used to request tokens or authorization codes via the browser. This process typically involves authentication of the end-user and optionally consent.
\n","urlObject":{"path":["connect","authorize"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"1b45d4e3-270b-4d7d-9a6f-82f072b391d5","name":"OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"description":"(Required) Identifier of the client.","key":"client_id","value":"eiusmod commodo nisi dolor veniam"},{"description":"(Required) One or more registered scopes.","key":"scope","value":"in mollit"},{"description":"(Required) The redirect URIs for the client.","key":"redirect_uri","value":"sint incididunt enim aliqua nisi"},{"description":"(Required) The response type: code, ideneity token and/or access token.","key":"response_type","value":"id_token token"},{"description":"Sends the token response as a form post instead of a fragment encoded redirect.","key":"response_mode","value":"form_post"},{"description":"Instead of providing all parameters as individual query string parameters, you can provide a subset or all of them as a JWT.","key":"request","value":"pariatur Excepteur"},{"description":"URL of a pre-packaged JWT containing request parameters","key":"request_uri","value":"ex aute velit tempor"},{"description":"The authorisation server will echo back the state value on the token response, this is for round tripping state between client and provider, correlating request and response and CSRF/replay protection. (recommended).","key":"state","value":"Excepteur"},{"description":"The authorisation server will echo back the nonce value in the identity token, this is for replay protection. Required for identity tokens via implicit grant.","key":"nonce","value":"dolore ut"},{"description":"The login UI will be shown or not.","key":"prompt","value":"none"},{"description":"Sends the code challenge for PKCE.","key":"code_challenge","value":"officia laboris eiusmod"},{"description":"Plain indicates that the challenge is using plain text (not recommended) S256 indicates the challenge is hashed with SHA256.","key":"code_challenge_method","value":"S256"},{"description":"Can be used to pre-fill the username field on the login page.","key":"login_hint","value":"qui sint nisi do"},{"description":"Gives a hint about the desired display language of the login UI.","key":"ui_locales","value":"fugiat co"},{"description":"If the user’s logon session exceeds the max age (in seconds), the login UI will be shown.","key":"max_age","value":"proident ipsum consectetur"}]},"url":"https://dev.ipv.com/CuratorGateway/connect/authorize"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"scope\": \"Duis proident adipisicing enim\",\n \"code\": \"veniam ad magna\",\n \"access_token\": \"ut cillum\",\n \"token_endpoint\": \"consequat aliquip\",\n \"expires_in\": \"ea sint\",\n \"token_type\": \"cillu\",\n \"refresh_token\": \"culpa Ut in aliqua ex\",\n \"id_token\": \"pariatur sed ut commodo\",\n \"state\": \"ullamco aute\",\n \"error\": \"id in fugiat exercitation aliquip\",\n \"error_description\": \"pariatur labor\"\n}"}],"_postman_id":"df19ebfe-2096-4270-8443-5bb88efc837c"},{"name":"Programmatically request tokens.","id":"f457bc45-844f-4b14-a5c6-54c7ddfff886","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"esse in est ut aliquip","description":"(Required) The client identifier.
\n"},{"key":"client_secret","value":"reprehenderit adipisicing","description":"(Required) Client secret either in the post body, or as a basic authentication header. Optional.
\n"},{"key":"grant_type","value":"refresh_token","description":"(Required) The grant type (flow) to use. Custom grant types can be added.
\n"},{"key":"scope","value":"in nostrud a","description":"One or more registered scopes. If not specified, a token for all explicitly allowed scopes will be issued.
\n"},{"key":"redirect_uri","value":"in eu","description":"Required for the authorization_code grant type.
\n"},{"key":"code","value":"labore commodo","description":"The authorization code (required for authorization_code grant type).
\n"},{"key":"code_verifier","value":"nostrud pariatur","description":"PKCE proof key.
\n"},{"key":"username","value":"occaecat aliqua","description":"Resource owner username (required for password grant type).
\n"},{"key":"password","value":"ad magna","description":"Resource owner password (required for password grant type).
\n"},{"key":"refresh_token","value":"adipisicing in","description":"The refresh token (required for refresh_token grant type).
\n"},{"key":"device_code","value":"cillum nisi ut mollit","description":"The device code (required for urn:ietf:params:oauth:grant-type:device_code grant type).
\n"}]},"url":"https://dev.ipv.com/CuratorGateway/connect/token","description":"The token endpoint can be used to programmatically request tokens.
\n","urlObject":{"path":["connect","token"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"f1d14c4c-e8c2-4c06-88f6-74fbf02c7877","name":"OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"description":"(Required) The client identifier.","key":"client_id","value":"esse in est ut aliquip"},{"description":"(Required) Client secret either in the post body, or as a basic authentication header. Optional.","key":"client_secret","value":"reprehenderit adipisicing"},{"description":"(Required) The grant type (flow) to use. Custom grant types can be added.","key":"grant_type","value":"refresh_token"},{"description":"One or more registered scopes. If not specified, a token for all explicitly allowed scopes will be issued.","key":"scope","value":"in nostrud a"},{"description":"Required for the authorization_code grant type.","key":"redirect_uri","value":"in eu"},{"description":"The authorization code (required for authorization_code grant type).","key":"code","value":"labore commodo"},{"description":"PKCE proof key.","key":"code_verifier","value":"nostrud pariatur"},{"description":"Resource owner username (required for password grant type).","key":"username","value":"occaecat aliqua"},{"description":"Resource owner password (required for password grant type).","key":"password","value":"ad magna"},{"description":"The refresh token (required for refresh_token grant type).","key":"refresh_token","value":"adipisicing in"},{"description":"The device code (required for urn:ietf:params:oauth:grant-type:device_code grant type).","key":"device_code","value":"cillum nisi ut mollit"}]},"url":"https://dev.ipv.com/CuratorGateway/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"in incididunt\",\n \"expires_in\": \"commodo qui nisi irure ad\",\n \"token_type\": \"Excepteur anim\",\n \"refresh_token\": \"consectetur Ut do\",\n \"id_token\": \"deserunt Lorem laboris\",\n \"scope\": \"minim proident Duis\",\n \"error\": \"qui ullamco proident Duis\",\n \"error_description\": \"consequat\"\n}"}],"_postman_id":"f457bc45-844f-4b14-a5c6-54c7ddfff886"},{"name":"Programmatically request tokens. Copy","id":"5aab8490-ace7-4d77-bc18-f19ce75d460f","request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"esse in est ut aliquip","description":"(Required) The client identifier.
\n"},{"key":"client_secret","value":"reprehenderit adipisicing","description":"(Required) Client secret either in the post body, or as a basic authentication header. Optional.
\n"},{"key":"grant_type","value":"refresh_token","description":"(Required) The grant type (flow) to use. Custom grant types can be added.
\n"},{"key":"scope","value":"in nostrud a","description":"One or more registered scopes. If not specified, a token for all explicitly allowed scopes will be issued.
\n"},{"key":"redirect_uri","value":"in eu","description":"Required for the authorization_code grant type.
\n"},{"key":"code","value":"labore commodo","description":"The authorization code (required for authorization_code grant type).
\n"},{"key":"code_verifier","value":"nostrud pariatur","description":"PKCE proof key.
\n"},{"key":"username","value":"occaecat aliqua","description":"Resource owner username (required for password grant type).
\n"},{"key":"password","value":"ad magna","description":"Resource owner password (required for password grant type).
\n"},{"key":"refresh_token","value":"adipisicing in","description":"The refresh token (required for refresh_token grant type).
\n"},{"key":"device_code","value":"cillum nisi ut mollit","description":"The device code (required for urn:ietf:params:oauth:grant-type:device_code grant type).
\n"}]},"url":"https://dev.ipv.com/CuratorGateway/connect/token","description":"The token endpoint can be used to programmatically request tokens.
\n","urlObject":{"path":["connect","token"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"c81c1e43-e3ee-4f0a-95b6-5d466ef87d2f","name":"OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"description":"(Required) The client identifier.","key":"client_id","value":"esse in est ut aliquip"},{"description":"(Required) Client secret either in the post body, or as a basic authentication header. Optional.","key":"client_secret","value":"reprehenderit adipisicing"},{"description":"(Required) The grant type (flow) to use. Custom grant types can be added.","key":"grant_type","value":"refresh_token"},{"description":"One or more registered scopes. If not specified, a token for all explicitly allowed scopes will be issued.","key":"scope","value":"in nostrud a"},{"description":"Required for the authorization_code grant type.","key":"redirect_uri","value":"in eu"},{"description":"The authorization code (required for authorization_code grant type).","key":"code","value":"labore commodo"},{"description":"PKCE proof key.","key":"code_verifier","value":"nostrud pariatur"},{"description":"Resource owner username (required for password grant type).","key":"username","value":"occaecat aliqua"},{"description":"Resource owner password (required for password grant type).","key":"password","value":"ad magna"},{"description":"The refresh token (required for refresh_token grant type).","key":"refresh_token","value":"adipisicing in"},{"description":"The device code (required for urn:ietf:params:oauth:grant-type:device_code grant type).","key":"device_code","value":"cillum nisi ut mollit"}]},"url":"https://dev.ipv.com/CuratorGateway/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"in incididunt\",\n \"expires_in\": \"commodo qui nisi irure ad\",\n \"token_type\": \"Excepteur anim\",\n \"refresh_token\": \"consectetur Ut do\",\n \"id_token\": \"deserunt Lorem laboris\",\n \"scope\": \"minim proident Duis\",\n \"error\": \"qui ullamco proident Duis\",\n \"error_description\": \"consequat\"\n}"}],"_postman_id":"5aab8490-ace7-4d77-bc18-f19ce75d460f"},{"name":"Returns OpenId Connect metadata related to the Curator authorisation server.","id":"c0b61156-d434-41cf-9085-9a7b3f08a6b6","request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://dev.ipv.com/CuratorGateway/.well-known/openid-configuration","description":"The discovery endpoint can be used to return OpenID Connect metadata related to the Curator authorisation server. It returns information like the issuer name, key material, supported scopes etc.
\n","urlObject":{"path":[".well-known","openid-configuration"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[]}},"response":[{"id":"bbf77403-c8d2-4aeb-857a-d8dd2c6f5fcd","name":"OK","originalRequest":{"method":"GET","header":[],"url":"https://dev.ipv.com/CuratorGateway/.well-known/openid-configuration"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"issuer\": \"https://myserver/curatorgateway\",\n \"jwks_uri\": \"https://myserver/CuratorGateway/.well-known/openid-configuration/jwks\",\n \"authorization_endpoint\": \"https://myserver/CuratorGateway/connect/authorize\",\n \"token_endpoint\": \"https://myserver/CuratorGateway/connect/token\",\n \"userinfo_endpoint\": \"https://myserver/CuratorGateway/connect/userinfo\",\n \"end_session_endpoint\": \"https://myserver/CuratorGateway/connect/endsession\",\n \"check_session_iframe\": \"https://myserver/CuratorGateway/connect/checksession\",\n \"revocation_endpoint\": \"https://myserver/CuratorGateway/connect/revocation\",\n \"introspection_endpoint\": \"https://myserver/CuratorGateway/connect/introspect\",\n \"device_authorization_endpoint\": \"https://myserver/CuratorGateway/connect/deviceauthorization\",\n \"frontchannel_logout_supported\": true,\n \"frontchannel_logout_session_supported\": true,\n \"backchannel_logout_supported\": true,\n \"backchannel_logout_session_supported\": true,\n \"scopes_supported\": [\n \"openid\",\n \"profile\",\n \"email\",\n \"address\",\n \"phone\",\n \"roles\",\n \"Curator.DeviceDirector.API\",\n \"Curator.Gateway.API\",\n \"Curator.ProcessEngine.API\",\n \"Curator.Proxies\",\n \"Curator.Server.API\",\n \"Curator.Siphon.API\",\n \"Curator.SVUtils.API\",\n \"Curator.XChange.API\",\n \"offline_access\"\n ],\n \"claims_supported\": [\n \"sub\",\n \"name\",\n \"family_name\",\n \"given_name\",\n \"middle_name\",\n \"nickname\",\n \"preferred_username\",\n \"profile\",\n \"picture\",\n \"website\",\n \"gender\",\n \"birthdate\",\n \"zoneinfo\",\n \"locale\",\n \"updated_at\",\n \"email\",\n \"email_verified\",\n \"address\",\n \"phone_number\",\n \"phone_number_verified\",\n \"role\",\n \"http://schemas.microsoft.com/ws/2008/06/identity/claims/role\"\n ],\n \"grant_types_supported\": [\n \"authorization_code\",\n \"client_credentials\",\n \"refresh_token\",\n \"implicit\",\n \"password\",\n \"urn:ietf:params:oauth:grant-type:device_code\",\n \"delegation\"\n ],\n \"response_types_supported\": [\n \"code\",\n \"token\",\n \"id_token\",\n \"id_token token\",\n \"code id_token\",\n \"code token\",\n \"code id_token token\"\n ],\n \"response_modes_supported\": [\n \"form_post\",\n \"query\",\n \"fragment\"\n ],\n \"token_endpoint_auth_methods_supported\": [\n \"client_secret_basic\",\n \"client_secret_post\"\n ],\n \"id_token_signing_alg_values_supported\": [\n \"RS256\"\n ],\n \"subject_types_supported\": [\n \"public\"\n ],\n \"code_challenge_methods_supported\": [\n \"plain\",\n \"S256\"\n ],\n \"request_parameter_supported\": true\n}"}],"_postman_id":"c0b61156-d434-41cf-9085-9a7b3f08a6b6"}],"id":"fb7383dc-449c-4692-8142-6a3c75fefae6","_postman_id":"fb7383dc-449c-4692-8142-6a3c75fefae6","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":"Returns the asynchronous task details.
\n","urlObject":{"path":["api","v1","tasks",":taskId"],"host":["https://dev.ipv.com/CuratorGateway"],"query":[],"variable":[{"id":"eb0a0cdf-b9fa-4a17-bc2e-38a661f161b0","description":{"content":"(Required) The id of the task to get.
\n","type":"text/plain"},"type":"any","value":"PE-a00c748c-568f-468b-89b3-0c82fbaf0d15","key":"taskId"}]}},"response":[{"id":"3e474b8a-347b-466c-87bf-5ea2ddd74970","name":"Returned if the request is successful.","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"