{ "opencollection": "1.0.0", "info": { "name": "Digital Identity Management", "version": "4.0.0" }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "search users for their identity details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/identity", "headers": [ { "name": "transactionId", "value": "" } ], "params": [ { "name": "bearerToken", "value": "", "type": "query", "description": "Bearer token for Auth0 authentication" }, { "name": "assetId", "value": "", "type": "query", "description": "Query string to search for users." }, { "name": "page", "value": "", "type": "query", "description": "Page index of the results to return. First page is 0." }, { "name": "perPage", "value": "", "type": "query", "description": "Number of results per page. Defaults to 50." }, { "name": "totals", "value": "", "type": "query", "description": "If true, the query will return the total number of items that match." }, { "name": "sort", "value": "", "type": "query", "description": "The field to use for sorting. Use `field:1` for ascending order and `field:-1` for descending order." }, { "name": "connection", "value": "", "type": "query", "description": "The name of the connection to use for the search." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include or exclude from the result. Eg. \"user_id,email,email_verified\". Leave empty to retrieve all fields." }, { "name": "includeFields", "value": "", "type": "query", "description": "Whether to include or exclude the fields specified in the `fields` parameter. Defaults to true." }, { "name": "searchEngine", "value": "", "type": "query", "description": "The version of the search engine to use. Defaults to \"v3\"." } ] }, "docs": "This operation list or find DigitalIdentity entities" }, { "info": { "name": "Update a user", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/update/users/:id", "headers": [ { "name": "transactionId", "value": "" } ], "params": [ { "name": "bearerToken", "value": "", "type": "query", "description": "Bearer token for Auth0 authentication" }, { "name": "id", "value": "", "type": "path", "description": "The identifier of the user to update." } ] }, "docs": "Updates a user with the object's properties received in the request's body (the object should be a JSON object). These are the attributes that can be updated at the root" }, { "info": { "name": "Get a user by Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users/:id", "headers": [ { "name": "transactionId", "value": "" } ], "params": [ { "name": "bearerToken", "value": "", "type": "query", "description": "Bearer token for Auth0 authentication" }, { "name": "id", "value": "", "type": "path", "description": "The identifier of the user whose details to be fetched." } ] }, "docs": "Retrieve user details by specific user Id" } ] }, { "info": { "name": "Organizations", "type": "folder" }, "items": [ { "info": { "name": "Get all invitations to organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organizations/:id/invitations", "headers": [ { "name": "transactionId", "value": "" } ], "params": [ { "name": "bearerToken", "value": "", "type": "query", "description": "Bearer token for Auth0 authentication" }, { "name": "id", "value": "", "type": "path", "description": "The ID of the organization." }, { "name": "page", "value": "", "type": "query", "description": "Page index of the results to return. First page is 0." }, { "name": "per_page", "value": "", "type": "query", "description": "Number of results per page. Defaults to 50." }, { "name": "totals", "value": "", "type": "query", "description": "If true, the query response will include the total number of items that match the query." }, { "name": "fields", "value": "", "type": "query", "description": "A comma-separated list of fields to include or exclude from the result (depending on the value of `include_fields`). Eg. \"id,name\". Leave empty to retrieve all fields." }, { "name": "include_fields", "value": "", "type": "query", "description": "Whether the fields specified are to be included in the result, defaults to true." }, { "name": "sort", "value": "", "type": "query", "description": "The field to sort the results by." } ] }, "docs": "Retrieves all invitations to an organization." }, { "info": { "name": "Create invitations to organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organizations/:id/invitations", "headers": [ { "name": "transactionId", "value": "" } ], "params": [ { "name": "bearerToken", "value": "", "type": "query", "description": "Bearer token for Auth0 authentication" }, { "name": "id", "value": "", "type": "path", "description": "The ID of the organization." } ] }, "docs": "Creates an invitation for a user to join an organization." }, { "info": { "name": "Delete invitations by Invitation ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organizations/:id/invitations/:invitationId", "headers": [ { "name": "transactionId", "value": "" } ], "params": [ { "name": "bearerToken", "value": "", "type": "query", "description": "Bearer token for Auth0 authentication" }, { "name": "id", "value": "", "type": "path", "description": "The ID of the organization." }, { "name": "invitationId", "value": "", "type": "path", "description": "The invitation ID that needs to be deleted" } ] }, "docs": "Delete invitations by Invitation ID" }, { "info": { "name": "Assign one or more roles to a member of an organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organizations/:id/members/roles/:userId", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the organization." }, { "name": "userId", "value": "", "type": "path", "description": "The ID of the user." } ] }, "docs": "This endpoint assigns one or more roles to a member of an organization." }, { "info": { "name": "Remove one or more roles from a given user in the context of the provided organization", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organizations/:id/members/roles/:userId", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the organization." }, { "name": "userId", "value": "", "type": "path", "description": "The ID of the user." } ] }, "docs": "This endpoint deletes one or more roles of a member in an organization." } ] } ], "bundled": true }