openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 68 kB

JSON

{"openapi":"3.0.0","info":{"description":"Use these REST APIs for performing operations on User entity in Azure API Management deployment. The User entity in API Management represents the developers that call the APIs of the products to which they are subscribed.","title":"ApiManagementClient","version":"2019-12-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2019-12-01-preview/apimusers.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimusers","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users":{"get":{"description":"Lists a collection of registered users in the specified service instance.","operationId":"User_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListUsers":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementListUsers":{"value":"apimService1"}}},{"description":"| 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 | | | ","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"Detailed Group in response.","in":"query","name":"expandGroups","schema":{"type":"boolean"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListUsers":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListUsers":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of User entities.","content":{"application/json":{"schema":{"description":"Paged Users list representation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"User details.","properties":{"properties":{"allOf":[{"description":"User Entity Base Parameters set.","properties":{"identities":{"description":"Collection of user identities.","items":{"description":"User identity details.","properties":{"id":{"description":"Identifier value within provider.","type":"string"},"provider":{"description":"Identity provider name.","type":"string"}}},"type":"array"},"note":{"description":"Optional note about a user set by the administrator.","type":"string"},"state":{"default":"active","description":"Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.","enum":["active","blocked","pending","deleted"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"UserState","values":[{"description":"User state is active.","value":"active"},{"description":"User is blocked. Blocked users cannot authenticate at developer portal or call API.","value":"blocked"},{"description":"User account is pending. Requires identity confirmation before it can be made active.","value":"pending"},{"description":"User account is closed. All identities and related entities are removed.","value":"deleted"}]}}}}],"description":"User profile.","properties":{"email":{"description":"Email address.","type":"string"},"firstName":{"description":"First name.","type":"string"},"groups":{"description":"Collection of groups user is part of.","items":{"description":"Group contract Properties.","properties":{"builtIn":{"description":"true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.","readOnly":true,"type":"boolean"},"description":{"description":"Group description. Can contain HTML formatting tags.","maxLength":1000,"type":"string"},"displayName":{"description":"Group name.","maxLength":300,"minLength":1,"type":"string"},"externalId":{"description":"For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.","type":"string"},"type":{"description":"Group type.","enum":["custom","system","external"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"GroupType"}}},"required":["displayName"]},"readOnly":true,"type":"array"},"lastName":{"description":"Last name.","type":"string"},"registrationDate":{"description":"Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n","format":"date-time","type":"string"}}}}},"type":"array"}}},"examples":{"ApiManagementListUsers":{"$ref":"#/components/examples/ApiManagementListUsers"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["User"],"x-ms-odata":"./definitions.json#/definitions/UserContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}":{"delete":{"description":"Deletes specific user.","operationId":"User_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteUser":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementDeleteUser":{"value":"apimService1"}}},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"userId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementDeleteUser":{"value":"5931a75ae4bbd512288c680b"}}},{"description":"Whether to delete user's subscription or not.","in":"query","name":"deleteSubscriptions","required":false,"schema":{"type":"boolean"}},{"description":"Send an Account Closed Email notification to the User.","in":"query","name":"notify","required":false,"schema":{"type":"boolean"}},{"description":"ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","in":"header","name":"If-Match","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteUser":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteUser":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteUser":{"value":"subid"}}}],"responses":{"200":{"description":"The user details were successfully deleted."},"204":{"description":"The user details were successfully deleted."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["User"]},"get":{"description":"Gets the details of the user specified by its identifier.","operationId":"User_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetUser":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementGetUser":{"value":"apimService1"}}},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"userId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementGetUser":{"value":"5931a75ae4bbd512a88c680b"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetUser":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetUser":{"value":"subid"}}}],"responses":{"200":{"description":"Gets the specified user entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"User details.","properties":{"properties":{"allOf":[{"description":"User Entity Base Parameters set.","properties":{"identities":{"description":"Collection of user identities.","items":{"description":"User identity details.","properties":{"id":{"description":"Identifier value within provider.","type":"string"},"provider":{"description":"Identity provider name.","type":"string"}}},"type":"array"},"note":{"description":"Optional note about a user set by the administrator.","type":"string"},"state":{"default":"active","description":"Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.","enum":["active","blocked","pending","deleted"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"UserState","values":[{"description":"User state is active.","value":"active"},{"description":"User is blocked. Blocked users cannot authenticate at developer portal or call API.","value":"blocked"},{"description":"User account is pending. Requires identity confirmation before it can be made active.","value":"pending"},{"description":"User account is closed. All identities and related entities are removed.","value":"deleted"}]}}}}],"description":"User profile.","properties":{"email":{"description":"Email address.","type":"string"},"firstName":{"description":"First name.","type":"string"},"groups":{"description":"Collection of groups user is part of.","items":{"description":"Group contract Properties.","properties":{"builtIn":{"description":"true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.","readOnly":true,"type":"boolean"},"description":{"description":"Group description. Can contain HTML formatting tags.","maxLength":1000,"type":"string"},"displayName":{"description":"Group name.","maxLength":300,"minLength":1,"type":"string"},"externalId":{"description":"For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.","type":"string"},"type":{"description":"Group type.","enum":["custom","system","external"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"GroupType"}}},"required":["displayName"]},"readOnly":true,"type":"array"},"lastName":{"description":"Last name.","type":"string"},"registrationDate":{"description":"Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n","format":"date-time","type":"string"}}}}},"examples":{"ApiManagementGetUser":{"$ref":"#/components/examples/ApiManagementGetUser"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["User"]},"head":{"description":"Gets the entity state (Etag) version of the user specified by its identifier.","operationId":"User_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadUser":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementHeadUser":{"value":"apimService1"}}},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"userId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementHeadUser":{"value":"5931a75ae4bbd512a88c680b"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadUser":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadUser":{"value":"subid"}}}],"responses":{"200":{"description":"Specified user entity exists and current entity state version is present in the ETag header.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["User"]},"patch":{"description":"Updates the details of the user specified by its identifier.","operationId":"User_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateUser":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementUpdateUser":{"value":"apimService1"}}},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"userId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementUpdateUser":{"value":"5931a75ae4bbd512288c680b"}}},{"description":"ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.","in":"header","name":"If-Match","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateUser":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateUser":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateUser":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"User update parameters.","properties":{"properties":{"allOf":[{"description":"User Entity Base Parameters set.","properties":{"identities":{"description":"Collection of user identities.","items":{"description":"User identity details.","properties":{"id":{"description":"Identifier value within provider.","type":"string"},"provider":{"description":"Identity provider name.","type":"string"}}},"type":"array"},"note":{"description":"Optional note about a user set by the administrator.","type":"string"},"state":{"default":"active","description":"Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.","enum":["active","blocked","pending","deleted"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"UserState","values":[{"description":"User state is active.","value":"active"},{"description":"User is blocked. Blocked users cannot authenticate at developer portal or call API.","value":"blocked"},{"description":"User account is pending. Requires identity confirmation before it can be made active.","value":"pending"},{"description":"User account is closed. All identities and related entities are removed.","value":"deleted"}]}}}}],"description":"Parameters supplied to the Update User operation.","properties":{"email":{"description":"Email address. Must not be empty and must be unique within the service instance.","maxLength":254,"minLength":1,"type":"string"},"firstName":{"description":"First name.","maxLength":100,"minLength":1,"type":"string"},"lastName":{"description":"Last name.","maxLength":100,"minLength":1,"type":"string"},"password":{"description":"User Password.","type":"string"}}}}}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"The user details were successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["User"]},"put":{"description":"Creates or Updates a user.","operationId":"User_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateUser":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementCreateUser":{"value":"apimService1"}}},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"userId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementCreateUser":{"value":"5931a75ae4bbd512288c680b"}}},{"description":"ETag of the Entity. Not required when creating an entity, but required when updating an entity.","in":"header","name":"If-Match","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateUser":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateUser":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"User create details.","properties":{"properties":{"allOf":[{"description":"User Entity Base Parameters set.","properties":{"identities":{"description":"Collection of user identities.","items":{"description":"User identity details.","properties":{"id":{"description":"Identifier value within provider.","type":"string"},"provider":{"description":"Identity provider name.","type":"string"}}},"type":"array"},"note":{"description":"Optional note about a user set by the administrator.","type":"string"},"state":{"default":"active","description":"Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.","enum":["active","blocked","pending","deleted"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"UserState","values":[{"description":"User state is active.","value":"active"},{"description":"User is blocked. Blocked users cannot authenticate at developer portal or call API.","value":"blocked"},{"description":"User account is pending. Requires identity confirmation before it can be made active.","value":"pending"},{"description":"User account is closed. All identities and related entities are removed.","value":"deleted"}]}}}}],"description":"Parameters supplied to the Create User operation.","properties":{"appType":{"description":"Determines the type of application which send the create user request. Default is old publisher portal.","enum":["developerPortal"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"AppType","values":[{"description":"User create request was sent by new developer portal.","value":"developerPortal"}]}},"confirmation":{"description":"Determines the type of confirmation e-mail that will be sent to the newly created user.","enum":["signup","invite"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"Confirmation","values":[{"description":"Send an e-mail to the user confirming they have successfully signed up.","value":"signup"},{"description":"Send an e-mail inviting the user to sign-up and complete registration.","value":"invite"}]}},"email":{"description":"Email address. Must not be empty and must be unique within the service instance.","maxLength":254,"minLength":1,"type":"string"},"firstName":{"description":"First name.","maxLength":100,"minLength":1,"type":"string"},"lastName":{"description":"Last name.","maxLength":100,"minLength":1,"type":"string"},"password":{"description":"User Password. If no value is provided, a default password is generated.","type":"string"}},"required":["email","firstName","lastName"]}}}}},"description":"Create or update parameters.","required":true},"responses":{"200":{"description":"User was successfully updated.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"User details.","properties":{"properties":{"allOf":[{"description":"User Entity Base Parameters set.","properties":{"identities":{"description":"Collection of user identities.","items":{"description":"User identity details.","properties":{"id":{"description":"Identifier value within provider.","type":"string"},"provider":{"description":"Identity provider name.","type":"string"}}},"type":"array"},"note":{"description":"Optional note about a user set by the administrator.","type":"string"},"state":{"default":"active","description":"Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.","enum":["active","blocked","pending","deleted"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"UserState","values":[{"description":"User state is active.","value":"active"},{"description":"User is blocked. Blocked users cannot authenticate at developer portal or call API.","value":"blocked"},{"description":"User account is pending. Requires identity confirmation before it can be made active.","value":"pending"},{"description":"User account is closed. All identities and related entities are removed.","value":"deleted"}]}}}}],"description":"User profile.","properties":{"email":{"description":"Email address.","type":"string"},"firstName":{"description":"First name.","type":"string"},"groups":{"description":"Collection of groups user is part of.","items":{"description":"Group contract Properties.","properties":{"builtIn":{"description":"true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.","readOnly":true,"type":"boolean"},"description":{"description":"Group description. Can contain HTML formatting tags.","maxLength":1000,"type":"string"},"displayName":{"description":"Group name.","maxLength":300,"minLength":1,"type":"string"},"externalId":{"description":"For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.","type":"string"},"type":{"description":"Group type.","enum":["custom","system","external"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"GroupType"}}},"required":["displayName"]},"readOnly":true,"type":"array"},"lastName":{"description":"Last name.","type":"string"},"registrationDate":{"description":"Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n","format":"date-time","type":"string"}}}}},"examples":{"ApiManagementCreateUser":{"$ref":"#/components/examples/ApiManagementCreateUser"}}}}},"201":{"description":"User was successfully created.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"User details.","properties":{"properties":{"allOf":[{"description":"User Entity Base Parameters set.","properties":{"identities":{"description":"Collection of user identities.","items":{"description":"User identity details.","properties":{"id":{"description":"Identifier value within provider.","type":"string"},"provider":{"description":"Identity provider name.","type":"string"}}},"type":"array"},"note":{"description":"Optional note about a user set by the administrator.","type":"string"},"state":{"default":"active","description":"Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.","enum":["active","blocked","pending","deleted"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"UserState","values":[{"description":"User state is active.","value":"active"},{"description":"User is blocked. Blocked users cannot authenticate at developer portal or call API.","value":"blocked"},{"description":"User account is pending. Requires identity confirmation before it can be made active.","value":"pending"},{"description":"User account is closed. All identities and related entities are removed.","value":"deleted"}]}}}}],"description":"User profile.","properties":{"email":{"description":"Email address.","type":"string"},"firstName":{"description":"First name.","type":"string"},"groups":{"description":"Collection of groups user is part of.","items":{"description":"Group contract Properties.","properties":{"builtIn":{"description":"true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.","readOnly":true,"type":"boolean"},"description":{"description":"Group description. Can contain HTML formatting tags.","maxLength":1000,"type":"string"},"displayName":{"description":"Group name.","maxLength":300,"minLength":1,"type":"string"},"externalId":{"description":"For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.","type":"string"},"type":{"description":"Group type.","enum":["custom","system","external"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"GroupType"}}},"required":["displayName"]},"readOnly":true,"type":"array"},"lastName":{"description":"Last name.","type":"string"},"registrationDate":{"description":"Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n","format":"date-time","type":"string"}}}}},"examples":{"ApiManagementCreateUser":{"$ref":"#/components/examples/ApiManagementCreateUser"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["User"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/confirmations/password/send":{"post":{"description":"Sends confirmation","operationId":"UserConfirmationPassword_Send","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUserConfirmationPasswordSend":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementUserConfirmationPasswordSend":{"value":"apimService1"}}},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"userId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementUserConfirmationPasswordSend":{"value":"57127d485157a511ace86ae7"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUserConfirmationPasswordSend":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUserConfirmationPasswordSend":{"value":"subid"}}}],"responses":{"204":{"description":"Notification successfully sent"},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["UserConfirmationPasswordSend"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/generateSsoUrl":{"post":{"description":"Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.","operationId":"User_GenerateSsoUrl","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUserGenerateSsoUrl":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementUserGenerateSsoUrl":{"value":"apimService1"}}},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"userId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementUserGenerateSsoUrl":{"value":"57127d485157a511ace86ae7"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUserGenerateSsoUrl":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUserGenerateSsoUrl":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the single sign-on URL.","content":{"application/json":{"schema":{"description":"Generate SSO Url operations response details.","properties":{"value":{"description":"Redirect Url containing the SSO URL value.","type":"string"}}},"examples":{"ApiManagementUserGenerateSsoUrl":{"$ref":"#/components/examples/ApiManagementUserGenerateSsoUrl"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["Users"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/groups":{"get":{"description":"Lists all user groups.","operationId":"UserGroup_List","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListUserGroups":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementListUserGroups":{"value":"apimService1"}}},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"userId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementListUserGroups":{"value":"57681833a40f7eb6c49f6acf"}}},{"description":"| 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 | ","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListUserGroups":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListUserGroups":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of Group entities.","content":{"application/json":{"schema":{"description":"Paged Group list representation.","properties":{"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"allOf":[{"description":"The Resource definition.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type for API Management resource.","readOnly":true,"type":"string"}},"x-ms-azure-resource":true}],"description":"Contract details.","properties":{"properties":{"description":"Group contract Properties.","properties":{"builtIn":{"description":"true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.","readOnly":true,"type":"boolean"},"description":{"description":"Group description. Can contain HTML formatting tags.","maxLength":1000,"type":"string"},"displayName":{"description":"Group name.","maxLength":300,"minLength":1,"type":"string"},"externalId":{"description":"For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.","type":"string"},"type":{"description":"Group type.","enum":["custom","system","external"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"GroupType"}}},"required":["displayName"]}}},"type":"array"}}},"examples":{"ApiManagementListUserGroups":{"$ref":"#/components/examples/ApiManagementListUserGroups"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Response.","properties":{"error":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}}}},"tags":["UserGroup"],"x-ms-odata":"./definitions.json#/definitions/GroupContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/identities":{"get":{"description":"List of all user identities.","operationId":"UserIdentities_List","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListUserIdentities":{"value":"rg1"}}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"},"examples":{"ApiManagementListUserIdentities":{"value":"apimService1"}}},{"description":"User identifier. Must be unique in the current API Management service instance.","in":"path","name":"userId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":80},"examples":{"ApiManagementListUserIdentities":{"value":"57f2af53bb17172280f44057"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListUserIdentities":{"value":"2019-12-01-preview"}}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"ApiManagementListUserIdentities":{"value":"subid"}}}],"responses":{"200":{"description":"Lists of User Identities.","content":{"application/json":{"schema":{"description":"List of Users Identity list representation.","properties":{"count":{"description":"Total record count number across all pages.","format":"int64","type":"integer"},"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"User Identity values.","items":{"description":"User identity details.","properties":{"id":{"description":"Identifier value within provider.","type":"string"},"provider":{"description":"Identity provider name.","type":"string"}}},"type":"array"}}},"examples":{"ApiManagementListUserIdentities":{"$ref":"#/components/examples/ApiManagementListUserIdentities"}}}}},"default":{"description":"Error response describing why the operation f