{ "opencollection": "1.0.0", "info": { "name": "Identity Security Cloud V3 Access Profiles Identities API", "version": "3.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://{tenant}.api.identitynow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Identities", "type": "folder" }, "items": [ { "info": { "name": "List public identities", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.api.identitynow.com/v3/public-identities", "params": [ { "name": "add-core-filters", "value": "", "type": "query", "description": "Set to true to exclude incomplete identities and uncorrelated accounts from the results." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return. Maximum value is 250." }, { "name": "offset", "value": "", "type": "query", "description": "Offset into the full result set. Usually specified with limit to paginate through the results." }, { "name": "count", "value": "", "type": "query", "description": "If true, the total count of items in the full result set is included in the X-Total-Count response header. Only items in the current page are returned. Requesting a count can decrease performance." }, { "name": "filters", "value": "name eq \"John Smith\"", "type": "query", "description": "Filter results using the standard syntax described in V3 API Standard Collection Parameters. Filtering is supported for the following fields and operators: id (eq, in), name (eq, sw, co), alias (eq, sw, co), email (eq, sw, co), status (eq)." }, { "name": "sorters", "value": "name,-email", "type": "query", "description": "Sort results using the standard syntax. Sorting is supported for the following fields: name, alias, email." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://{tenant}.api.identitynow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a list of public identities. This endpoint returns a paged list of public identity objects that can be filtered and sorted." }, { "info": { "name": "Get a public identity", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.api.identitynow.com/v3/public-identities/:id", "params": [ { "name": "id", "value": "2c9180857182305e0171993735622948", "type": "path", "description": "The identity ID." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://{tenant}.api.identitynow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the details of a public identity by its ID." }, { "info": { "name": "List identity profiles", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.api.identitynow.com/v3/identity-profiles", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of results to return. Maximum value is 250." }, { "name": "offset", "value": "", "type": "query", "description": "Offset into the full result set. Usually specified with limit to paginate through the results." }, { "name": "count", "value": "", "type": "query", "description": "If true, the total count of items in the full result set is included in the X-Total-Count response header. Only items in the current page are returned. Requesting a count can decrease performance." }, { "name": "filters", "value": "name eq \"HR Profile\"", "type": "query", "description": "Filter results using the standard syntax. Filtering is supported for the following fields: id (eq, in), name (eq, sw), priority (eq, gt, lt, ge, le)." }, { "name": "sorters", "value": "name,-priority", "type": "query", "description": "Sort results using the standard syntax. Sorting is supported for the following fields: name, priority, created, modified." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://{tenant}.api.identitynow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get a list of identity profiles. Identity profiles define how identity attributes are mapped from source account attributes and configure lifecycle states." }, { "info": { "name": "Create an identity profile", "type": "http" }, "http": { "method": "POST", "url": "https://{tenant}.api.identitynow.com/v3/identity-profiles", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://{tenant}.api.identitynow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create an identity profile. An identity profile defines the mapping between source account attributes and identity attributes and configures lifecycle states for identities." }, { "info": { "name": "Get an identity profile", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant}.api.identitynow.com/v3/identity-profiles/:identity-profile-id", "params": [ { "name": "identity-profile-id", "value": "2b838de9-db9b-abcf-e646-d4f274ad4238", "type": "path", "description": "The identity profile ID." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://{tenant}.api.identitynow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get the details of an identity profile by its ID." }, { "info": { "name": "Update an identity profile", "type": "http" }, "http": { "method": "PATCH", "url": "https://{tenant}.api.identitynow.com/v3/identity-profiles/:identity-profile-id", "params": [ { "name": "identity-profile-id", "value": "2b838de9-db9b-abcf-e646-d4f274ad4238", "type": "path", "description": "The identity profile ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://{tenant}.api.identitynow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Update an existing identity profile using a JSON Patch document." }, { "info": { "name": "Delete an identity profile", "type": "http" }, "http": { "method": "DELETE", "url": "https://{tenant}.api.identitynow.com/v3/identity-profiles/:identity-profile-id", "params": [ { "name": "identity-profile-id", "value": "2b838de9-db9b-abcf-e646-d4f274ad4238", "type": "path", "description": "The identity profile ID." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://{tenant}.api.identitynow.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an identity profile by its ID." } ] } ], "bundled": true }