Create Password Resets - Cloud Security API

{"type":"api","title":"Create Password Resets","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/c24e887e-1827-3004-af8d-fdd6677097c8","info":{"title":"Cisco Umbrella Users and Roles API","version":"2.0.0","description":"Manage the Umbrella user accounts and roles.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Users"},{"name":"Roles"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/admin/users-roles-overview.md","uri":"umbrella-api-reference-users-roles-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"admin.users:read":"Read admin users","admin.users:write":"Write admin users","admin.roles:read":"Read admin roles","admin.passwordreset:write":"Write admin passwords","admin.organizations:write":"Read admin organizations"}}}}}},"spec":{"tags":["Users","Umbrella"],"description":"Renew the passwords for the user accounts in the child (customer) organization of a provider organization.\n\nFor each email address, Umbrella identifies the user's account and renews the password for the user account.\nUmbrella does not send a renewal request to the user account's email address.\n\nOnce an admin resets the user account password through the `/passwordResets/{customerId}` API endpoint,\na user can sign into their account on the child (customer) organization's managed console\nand reset the password for their user account.\n\nThe `/passwordResets/{customerId}` API endpoint is only available for parent (provider) organizations\non the Multi-org or provider console.","summary":"Create Password Resets","operationId":"createPasswordResets","security":[{"oauthFlow":["admin.passwordreset:write"]}],"parameters":[{"name":"customerId","in":"path","description":"The child (customer) organization ID.","required":true,"schema":{"type":"integer","format":"int32"},"example":1234556,"$$ref":"#/components/parameters/customerIdParam"}],"requestBody":{"description":"Provide a list of email addresses for the user accounts in a child (customer) organization.\nUmbrella renews the password for each user account identified by the account's email address.","content":{"application/json":{"schema":{"type":"object","description":"Renew the passwords for the user accounts in the child (customer) organization.","properties":{"adminEmails":{"type":"array","description":"A list of email addresses for the user accounts in a child (customer) organization.","items":{"type":"string","description":"An email address used to renew the user account's password.\nUmbrella does not send an email to the user account's email address.","example":"xac@adc.com"}}}},"example":{"adminEmails":["account@adc.com","account@cisco.com"]}}}},"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"string","description":"Created a password renewal request for each user account identified by the account's email address.","nullable":true},"example":""}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Invalid request"}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Unauthorized request"}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Forbidden"}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Not Found"}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}},"example":{"message":"Server error"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"createPasswordResets","method":"post","path":"/passwordResets/{customerId}"}}