{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-apimanagement-apimusers","description":"ApiManagementClient","version":"2019-12-01-preview","base_url":"https://management.azure.com","endpoints":12,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api ApiManagementClient\n@base https://management.azure.com\n@version 2019-12-01-preview\n@auth OAuth2\n@endpoints 12\n@toc subscriptions(12)\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users\n@desc Lists a collection of registered users in the specified service instance.\n@optional {$filter: any # |   Field     |     Usage     |     Supported operators     |     Supported functions     ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | filter | eq |     | | registrationDate | filter | ge, le, eq, ne, gt, lt |     | | note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | groups | expand |     |     |, expandGroups: any # Detailed Group in response.}\n@returns(200) Lists a collection of User entities.\n\n@endpoint HEAD /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}\n@desc Gets the entity state (Etag) version of the user specified by its identifier.\n@returns(200) Specified user entity exists and current entity state version is present in the ETag header.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}\n@desc Gets the details of the user specified by its identifier.\n@returns(200) Gets the specified user entity.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}\n@desc Creates or Updates a user.\n@required {parameters: any # Create or update parameters.}\n@returns(200) User was successfully updated.\n@returns(201) User was successfully created.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}\n@desc Updates the details of the user specified by its identifier.\n@required {parameters: any # Update parameters.}\n@returns(204) The user details were successfully updated.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}\n@desc Deletes specific user.\n@optional {deleteSubscriptions: any # Whether to delete user's subscription or not., notify: any # Send an Account Closed Email notification to the User.}\n@returns(200) The user details were successfully deleted.\n@returns(204) The user details were successfully deleted.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/generateSsoUrl\n@desc Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.\n@returns(200) The response body contains the single sign-on URL.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/groups\n@desc Lists all user groups.\n@optional {$filter: any # |   Field     |     Usage     |     Supported operators     |     Supported functions     ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |}\n@returns(200) Lists a collection of Group entities.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions\n@desc Lists the collection of subscriptions of the specified user.\n@optional {$filter: any # |   Field     |     Usage     |     Supported operators     |     Supported functions     ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |}\n@returns(200) Lists a collection of Subscription entities.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/identities\n@desc List of all user identities.\n@returns(200) Lists of User Identities.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/token\n@desc Gets the Shared Access Authorization Token for the User.\n@required {parameters: any # Create Authorization Token parameters.}\n@returns(200) The response body contains the authorization token for the user.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/confirmations/password/send\n@desc Sends confirmation\n@returns(204) Notification successfully sent\n\n@end\n"}