ApiManagementClient (apimanagement-apimgroups)
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.Technical Specifications
startFlow
- OnInit
- ./lib/triggers/startFlow.js
- OnStartup
- -
- OnClose
- -
Attributes
-
Group_ListByService
Lists a collection of groups defined within a service instance.
- OnInit
- ./lib/actions/Group_ListByService.js
- OnStartup
- -
- OnClose
- -
Attributes
-
Group_Delete
Deletes specific group of the API Management service instance.
- OnInit
- ./lib/actions/Group_Delete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
Group_Get
Gets the details of the group specified by its identifier.
- OnInit
- ./lib/actions/Group_Get.js
- OnStartup
- -
- OnClose
- -
Attributes
-
Group_GetEntityTag
Gets the entity state (Etag) version of the group specified by its identifier.
- OnInit
- ./lib/actions/Group_GetEntityTag.js
- OnStartup
- -
- OnClose
- -
Attributes
-
Group_Update
Updates the details of the group specified by its identifier.
- OnInit
- ./lib/actions/Group_Update.js
- OnStartup
- -
- OnClose
- -
Attributes
-
Group_CreateOrUpdate
Creates or Updates a group.
- OnInit
- ./lib/actions/Group_CreateOrUpdate.js
- OnStartup
- -
- OnClose
- -
Attributes
-
GroupUser_List
Lists a collection of user entities associated with the group.
- OnInit
- ./lib/actions/GroupUser_List.js
- OnStartup
- -
- OnClose
- -
Attributes
-
GroupUser_Delete
Remove existing user from existing group.
- OnInit
- ./lib/actions/GroupUser_Delete.js
- OnStartup
- -
- OnClose
- -
Attributes
-
GroupUser_CheckEntityExists
Checks that user entity specified by identifier is associated with the group entity.
- OnInit
- ./lib/actions/GroupUser_CheckEntityExists.js
- OnStartup
- -
- OnClose
- -
Attributes
-
GroupUser_Create
Add existing user to existing group
- OnInit
- ./lib/actions/GroupUser_Create.js
- OnStartup
- -
- OnClose
- -
Attributes
-
No data available for terms
OAUTH_CLIENT_ID
OAuth Client ID
- type
- -
- required
- -
- example
- -
OAUTH_CLIENT_SECRET
OAuth Client Secret
- type
- -
- required
- -
- example
- -