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 • 54.4 kB

JSON

{"openapi":"3.0.0","info":{"description":"Use these REST APIs for performing operations on Group entity in your Azure API Management deployment. Groups are used to manage the visibility of products to developers. Each API Management service instance comes with the following immutable system groups whose membership is automatically managed by API Management. - **Administrators** - Azure subscription administrators are members of this group. - **Developers** - Authenticated developer portal users fall into this group. - **Guests** - Unauthenticated developer portal users are placed into this group. In addition to these system groups, administrators can create custom groups or [leverage external groups in associated Azure Active Directory tenants](https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-aad#how-to-add-an-external-azure-active-directory-group). Custom and external groups can be used alongside system groups in giving developers visibility and access to API products. For example, you could create one custom group for developers affiliated with a specific partner organization and allow them access to the APIs from a product containing relevant APIs only. A user can be a member of more than one group.","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/apimgroups.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimgroups","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups":{"get":{"description":"Lists a collection of groups defined within a service instance.","externalDocs":{"url":"https://docs.microsoft.com/en-us/azure/api-management/api-management-howto-create-groups"},"operationId":"Group_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListGroups":{"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":{"ApiManagementListGroups":{"value":"apimService1"}}},{"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 | | aadObjectId | filter | eq | | ","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":{"ApiManagementListGroups":{"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":{"ApiManagementListGroups":{"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":{"ApiManagementListGroups":{"$ref":"#/components/examples/ApiManagementListGroups"}}}}},"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":["Group"],"x-ms-odata":"./definitions.json#/definitions/GroupContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}":{"delete":{"description":"Deletes specific group of the API Management service instance.","operationId":"Group_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteGroup":{"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":{"ApiManagementDeleteGroup":{"value":"apimService1"}}},{"description":"Group identifier. Must be unique in the current API Management service instance.","in":"path","name":"groupId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256},"examples":{"ApiManagementDeleteGroup":{"value":"aadGroup"}}},{"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":{"ApiManagementDeleteGroup":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteGroup":{"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":{"ApiManagementDeleteGroup":{"value":"subid"}}}],"responses":{"200":{"description":"The group was successfully deleted."},"204":{"description":"The group was 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":["Group"]},"get":{"description":"Gets the details of the group specified by its identifier.","operationId":"Group_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementGetGroup":{"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":{"ApiManagementGetGroup":{"value":"apimService1"}}},{"description":"Group identifier. Must be unique in the current API Management service instance.","in":"path","name":"groupId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256},"examples":{"ApiManagementGetGroup":{"value":"59306a29e4bbd510dc24e5f9"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementGetGroup":{"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":{"ApiManagementGetGroup":{"value":"subid"}}}],"responses":{"200":{"description":"The response body contains the specified Group 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":"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"]}}},"examples":{"ApiManagementGetGroup":{"$ref":"#/components/examples/ApiManagementGetGroup"}}}}},"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":["Group"]},"head":{"description":"Gets the entity state (Etag) version of the group specified by its identifier.","operationId":"Group_GetEntityTag","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadGroup":{"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":{"ApiManagementHeadGroup":{"value":"apimService1"}}},{"description":"Group identifier. Must be unique in the current API Management service instance.","in":"path","name":"groupId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256},"examples":{"ApiManagementHeadGroup":{"value":"59306a29e4bbd510dc24e5f9"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementHeadGroup":{"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":{"ApiManagementHeadGroup":{"value":"subid"}}}],"responses":{"200":{"description":"Specified group 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":["Group"]},"patch":{"description":"Updates the details of the group specified by its identifier.","operationId":"Group_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementUpdateGroup":{"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":{"ApiManagementUpdateGroup":{"value":"apimService1"}}},{"description":"Group identifier. Must be unique in the current API Management service instance.","in":"path","name":"groupId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256},"examples":{"ApiManagementUpdateGroup":{"value":"tempgroup"}}},{"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":{"ApiManagementUpdateGroup":{"value":"*"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementUpdateGroup":{"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":{"ApiManagementUpdateGroup":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Parameters supplied to the Update Group operation.","properties":{"properties":{"description":"Parameters supplied to the Update Group operation.","properties":{"description":{"description":"Group description.","type":"string"},"displayName":{"description":"Group name.","maxLength":300,"minLength":1,"type":"string"},"externalId":{"description":"Identifier of the 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"}}}}}}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"The group 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":["Group"]},"put":{"description":"Creates or Updates a group.","operationId":"Group_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateGroup":{"value":"rg1"},"ApiManagementCreateGroupExternal":{"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":{"ApiManagementCreateGroup":{"value":"apimService1"},"ApiManagementCreateGroupExternal":{"value":"apimService1"}}},{"description":"Group identifier. Must be unique in the current API Management service instance.","in":"path","name":"groupId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256},"examples":{"ApiManagementCreateGroup":{"value":"tempgroup"},"ApiManagementCreateGroupExternal":{"value":"aadGroup"}}},{"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":{"ApiManagementCreateGroup":{"value":"2019-12-01-preview"},"ApiManagementCreateGroupExternal":{"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":{"ApiManagementCreateGroup":{"value":"subid"},"ApiManagementCreateGroupExternal":{"value":"subid"}}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Parameters supplied to the Create Group operation.","properties":{"properties":{"description":"Parameters supplied to the Create Group operation.","properties":{"description":{"description":"Group description.","type":"string"},"displayName":{"description":"Group name.","maxLength":300,"minLength":1,"type":"string"},"externalId":{"description":"Identifier of the 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"]}}}}},"description":"Create parameters.","required":true},"responses":{"200":{"description":"Group already exists.","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":"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"]}}},"examples":{"ApiManagementCreateGroup":{"$ref":"#/components/examples/ApiManagementCreateGroup"},"ApiManagementCreateGroupExternal":{"$ref":"#/components/examples/ApiManagementCreateGroupExternal"}}}}},"201":{"description":"Group was created successfully.","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":"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"]}}},"examples":{"ApiManagementCreateGroup":{"$ref":"#/components/examples/ApiManagementCreateGroup"},"ApiManagementCreateGroupExternal":{"$ref":"#/components/examples/ApiManagementCreateGroupExternal"}}}}},"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":["Group"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users":{"get":{"description":"Lists a collection of user entities associated with the group.","operationId":"GroupUser_List","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementListGroupUsers":{"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":{"ApiManagementListGroupUsers":{"value":"apimService1"}}},{"description":"Group identifier. Must be unique in the current API Management service instance.","in":"path","name":"groupId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256},"examples":{"ApiManagementListGroupUsers":{"value":"57d2ef278aa04f0888cba3f3"}}},{"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 | | registrationDate | filter | ge, le, eq, ne, gt, lt | | | note | 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":{"ApiManagementListGroupUsers":{"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":{"ApiManagementListGroupUsers":{"value":"subid"}}}],"responses":{"200":{"description":"Lists a collection of user entities associated with the group.","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":{"ApiManagementListGroupUsers":{"$ref":"#/components/examples/ApiManagementListGroupUsers"}}}}},"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":["GroupUser"],"x-ms-odata":"./definitions.json#/definitions/UserContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{userId}":{"delete":{"description":"Remove existing user from existing group.","operationId":"GroupUser_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementDeleteGroupUser":{"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":{"ApiManagementDeleteGroupUser":{"value":"apimService1"}}},{"description":"Group identifier. Must be unique in the current API Management service instance.","in":"path","name":"groupId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256},"examples":{"ApiManagementDeleteGroupUser":{"value":"templategroup"}}},{"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":{"ApiManagementDeleteGroupUser":{"value":"59307d350af58404d8a26300"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementDeleteGroupUser":{"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":{"ApiManagementDeleteGroupUser":{"value":"subid"}}}],"responses":{"200":{"description":"The user was successfully removed from the group."},"204":{"description":"The user was successfully removed from the group."},"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":["GroupUser"]},"head":{"description":"Checks that user entity specified by identifier is associated with the group entity.","operationId":"GroupUser_CheckEntityExists","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementHeadGroupUser":{"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":{"ApiManagementHeadGroupUser":{"value":"apimService1"}}},{"description":"Group identifier. Must be unique in the current API Management service instance.","in":"path","name":"groupId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256},"examples":{"ApiManagementHeadGroupUser":{"value":"59306a29e4bbd510dc24e5f9"}}},{"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":{"ApiManagementHeadGroupUser":{"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":{"ApiManagementHeadGroupUser":{"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":{"ApiManagementHeadGroupUser":{"value":"subid"}}}],"responses":{"204":{"description":"Entity exists"},"404":{"description":"Entity does not exists."},"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":["GroupUser"]},"put":{"description":"Add existing user to existing group","operationId":"GroupUser_Create","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"ApiManagementCreateGroupUser":{"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":{"ApiManagementCreateGroupUser":{"value":"apimService1"}}},{"description":"Group identifier. Must be unique in the current API Management service instance.","in":"path","name":"groupId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":256},"examples":{"ApiManagementCreateGroupUser":{"value":"tempgroup"}}},{"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":{"ApiManagementCreateGroupUser":{"value":"59307d350af58404d8a26300"}}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"ApiManagementCreateGroupUser":{"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":{"ApiManagementCreateGroupUser":{"value":"subid"}}}],"responses":{"200":{"description":"The specified user is already a member of the specified group.","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":{"ApiManagementCreateGroupUser":{"$ref":"#/components/examples/ApiManagementCreateGroupUser"}}}}},"201":{"description":"The user was successfully added to the group.","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":{"ApiManagementCreateGroupUser":{"$ref":"#/components/examples/ApiManagementCreateGroupUser"}}}}},"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