{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure Cognitive Services Accounts Users API", "version": "3.2" }, "request": { "auth": { "type": "apikey", "key": "Ocp-Apim-Subscription-Key", "value": "{{Ocp-Apim-Subscription-Key}}", "placement": "header" } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Microsoft List users", "type": "http" }, "http": { "method": "GET", "url": "https://{region}.api.cognitive.microsoft.com/users", "params": [ { "name": "$top", "value": "", "type": "query", "description": "Number of items to return (page size)" }, { "name": "$skip", "value": "", "type": "query", "description": "Number of items to skip for pagination" }, { "name": "$filter", "value": "", "type": "query", "description": "OData filter expression" }, { "name": "$select", "value": "", "type": "query", "description": "Comma-separated list of properties to include in the response" }, { "name": "$orderby", "value": "", "type": "query", "description": "OData order by expression" }, { "name": "$search", "value": "", "type": "query", "description": "Search expression to filter results" }, { "name": "$count", "value": "", "type": "query", "description": "Include count of items in the response" } ] }, "docs": "Retrieve a list of user objects. By default, only a limited set of properties are returned. To return an alternative property set, specify the desired properties using the OData $select query parameter." }, { "info": { "name": "Microsoft Create user", "type": "http" }, "http": { "method": "POST", "url": "https://{region}.api.cognitive.microsoft.com/users", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user object. The request body contains the user to create. At a minimum, you must specify the required properties for the user, including displayName, mailNickname, userPrincipalName, and passwordProfile." }, { "info": { "name": "Microsoft Get user", "type": "http" }, "http": { "method": "GET", "url": "https://{region}.api.cognitive.microsoft.com/users/:user-id", "params": [ { "name": "user-id", "value": "", "type": "path", "description": "Unique identifier of the user (GUID or userPrincipalName)" }, { "name": "$select", "value": "", "type": "query", "description": "Comma-separated list of properties to include in the response" } ] }, "docs": "Retrieve the properties and relationships of a user object. Returns a default set of properties unless you use $select to specify specific properties." }, { "info": { "name": "Microsoft Update user", "type": "http" }, "http": { "method": "PATCH", "url": "https://{region}.api.cognitive.microsoft.com/users/:user-id", "params": [ { "name": "user-id", "value": "", "type": "path", "description": "Unique identifier of the user (GUID or userPrincipalName)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the properties of a user object. Not all properties can be updated by Member or Guest users with their default permissions." }, { "info": { "name": "Microsoft Delete user", "type": "http" }, "http": { "method": "DELETE", "url": "https://{region}.api.cognitive.microsoft.com/users/:user-id", "params": [ { "name": "user-id", "value": "", "type": "path", "description": "Unique identifier of the user (GUID or userPrincipalName)" } ] }, "docs": "Delete a user object. When deleted, user resources are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted." }, { "info": { "name": "Microsoft Get user's manager", "type": "http" }, "http": { "method": "GET", "url": "https://{region}.api.cognitive.microsoft.com/users/:user-id/manager", "params": [ { "name": "user-id", "value": "", "type": "path", "description": "Unique identifier of the user (GUID or userPrincipalName)" } ] }, "docs": "Returns the user or organizational contact assigned as the user's manager. Optionally, you can expand the manager's chain up to the root node." }, { "info": { "name": "Microsoft List user's direct reports", "type": "http" }, "http": { "method": "GET", "url": "https://{region}.api.cognitive.microsoft.com/users/:user-id/directReports", "params": [ { "name": "user-id", "value": "", "type": "path", "description": "Unique identifier of the user (GUID or userPrincipalName)" }, { "name": "$top", "value": "", "type": "query", "description": "Number of items to return (page size)" } ] }, "docs": "Get the users and organizational contacts that report to the user." }, { "info": { "name": "Microsoft List user's group memberships", "type": "http" }, "http": { "method": "GET", "url": "https://{region}.api.cognitive.microsoft.com/users/:user-id/memberOf", "params": [ { "name": "user-id", "value": "", "type": "path", "description": "Unique identifier of the user (GUID or userPrincipalName)" }, { "name": "$top", "value": "", "type": "query", "description": "Number of items to return (page size)" }, { "name": "$filter", "value": "", "type": "query", "description": "OData filter expression" } ] }, "docs": "Get the groups, directory roles, and administrative units that the user is a direct member of." } ] } ], "bundled": true }