Skip to content

Commit a5c7256

Browse files
adobeDavidTadobeDavidT
authored
Merge pull request #91 from rmccubbin/PROVEN-13080
Add User Group Sharing UMAPI docs
2 parents 26112c0 + 077a2ff commit a5c7256

6 files changed

Lines changed: 184 additions & 25 deletions

File tree

‎docs/en/api/ErrorRef.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -406,3 +406,12 @@ The possible error codes and messages are listed with their context and descript
406406
* **error.usergroup.exceeds_maximum_member_count**
407407
* add, remove
408408
* The current user count for the group exceeds the recommended size. Please refer to our [requesting help page](getSupport.html) if you would like to discuss this issue further.
409+
* **error.usergroup.readonly.update_not_allowed**
410+
* update
411+
* Attempting to modify a readonly group e.g. update the group name
412+
* **error.usergroup.readonly.add_user_not_allowed**
413+
* add
414+
* Attempting to add a user membership to a readonly group
415+
* **error.usergroup.readonly.remove_user_not_allowed**
416+
* remove
417+
* Attempting to remove a user membership from a readonly group

‎docs/en/api/getUserGroup.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ The response body contains the specified user-group in JSON format including the
6262
"adminGroupId": "42073423",
6363
"adminGroupName": "39127441USERGROUP_ADMIN_GROUP_NAME_SUFFIX",
6464
"userCount": 2,
65-
"adminCount": "1"
65+
"adminCount": "1",
66+
"isReadOnly": false
6667
}
6768
```
6869

@@ -85,6 +86,9 @@ The group type which will always be `USER_GROUP`.
8586
__userCount:__ _integer_
8687
The number of users in the group.
8788

89+
__isReadOnly:__ _boolean_
90+
Indicates if it is possible to directly add and remove users from the group. Groups shared from another organization will return true otherwise it will return false or not be present if not applicable. Further information is available at [Share User Groups](https://www.adobe.com/go/user_group_share)
91+
8892
#### Schema Model
8993

9094
```json
@@ -95,7 +99,8 @@ The number of users in the group.
9599
"groupId": integer,
96100
"name": "string",
97101
"type": "string",
98-
"userCount": integer
102+
"userCount": integer,
103+
"isReadOnly": boolean
99104
}
100105
```
101106

‎docs/en/api/getUserGroups.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,8 @@ Response with 3 user-groups including a user-group with administrators.
7575
"groupId": 44815360,
7676
"name": "UserGroup12",
7777
"type": "USER_GROUP",
78-
"userCount": 1
78+
"userCount": 1,
79+
"isReadOnly": true
7980
},
8081
{
8182
"groupId": 44382376,
@@ -106,6 +107,9 @@ The group type will always be `USER_GROUP`.
106107
__userCount:__ _long_
107108
The number of users in the group. {% include_relative partials/mayNotBePresent.md %}
108109

110+
__isReadOnly:__ _boolean_
111+
Indicates if it is possible to directly add and remove users from the group. Further information is available at [Share User Groups](https://www.adobe.com/go/user_group_share)
112+
109113
#### Schema Model
110114

111115
```json

‎docs/en/api/glossary.md‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,27 @@ lang: en
1111

1212
The following table defines common terms used throughout the User Management API documentation:
1313

14-
| Term | Meaning |
15-
| :---- | :--------------- |
16-
| Access Token | {% include_relative partials/authorizationDescription.md %} |
17-
| <a name="adminconsole" class="api-ref-subtitle">Admin Console</a> | A central location for managing your Adobe entitlements across your entire organization, available at https://adminconsole.adobe.com/enterprise. |
18-
| <a name="adobeId" class="api-ref-subtitle">AdobeID</a> | An Identity Type that is created, owned, and managed by the end user. Adobe performs authentication, and the end user manages the identity. Users retain complete control over files and data associated with their ID. See full discussion at [Identity Types](https://helpx.adobe.com/enterprise/help/identity.html). |
19-
| API Key | {% include_relative partials/apiKeyDescription.md %} |
20-
| <a name="deployment" class="api-ref-subtitle">Deployment Administrator</a> | Creates, manages, and deploys software packages and updates to end users. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#).|
21-
| <a name="developer" class="api-ref-subtitle">Developer</a> | Users given this role for a specific product profile are considered to be a developer for that product profile. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#).|
22-
| <a name="enterpriseId" class="api-ref-subtitle">Enterprise ID</a> | An Identity Type that is created, owned, and managed by an organization. Adobe hosts the Enterprise ID and performs authentication, but the organization maintains the Enterprise ID. End-users cannot sign up and create an Enterprise ID, nor can they sign up for additional products and services from Adobe using an Enterprise ID. See full discussion at [Identity Types](https://helpx.adobe.com/enterprise/help/identity.html). |
23-
| <a name="federatedId" class="api-ref-subtitle">Federated ID</a> | An Identity Type that is created and owned by an organization, and linked to the enterprise directory through federation. The organization manages credentials and processes Single Sign-On through a SAML2 identity provider. UMAPI clients with email-federated domains must always identity users by email. See full discussion at [Identity Types](https://helpx.adobe.com/enterprise/help/identity.html). |
24-
| <a name="unknownUserType" class="api-ref-subtitle">usertype `unknown`</a> | In some cases a userType may contain the value `unknown`. In these cases the user may not contain the necessary values to identify the user type.|
25-
| Group type | The group type is returned in user-group API responses. User-groups are always of type `USER_GROUP` |
26-
| <a name="identity" class="api-ref-subtitle">Identity Types</a> | The [Identity Types](https://helpx.adobe.com/enterprise/help/identity.html) resource explains the different account types that are available: Adobe, Enterprise, and Federated IDs. |
27-
| Organization ID | {% include_relative partials/orgIdDescription.md %} |
28-
| <a name="productAdmin" class="api-ref-subtitle">Product Administrator</a> | A user role in an organization. A user with this role (an admin) administers the assigned products, managing all associated administrative functions, such as creating product profiles and adding users and user-groups to the organization. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
29-
| <a name="productProfile" class="api-ref-subtitle">Product Profile</a> | A set of specific entitlements and roles for a product, defined in the Admin Console. Users and user groups can belong to product profiles. |
30-
| <a name="productProfileAdmin" class="api-ref-subtitle">Product Profile Administrator</a> | A user role in an organization. A user with this role administers assigned Product Profile descriptions, managing all associated administrative functions, such as adding and removing users from Product Profiles. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
31-
| <a name="orgAdmin" class="api-ref-subtitle">System Administrator</a> | A user role in an organization. A "super user" for the organization who is allowed to perform all administrative tasks, including the capabilities granted to User Group admin, Product admin, Product Profile admin, Support admin and Deployment admin. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
32-
| <a name="supportAdmin" class="api-ref-subtitle">Support Administrator</a> | See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
33-
| <a name="usergroup" class="api-ref-subtitle">User Group</a> | A group of loosely associated users. Typically used to organize a set of related users by department or function. For example: `U.S.FinanceOperations`, `EU Human Resources` |
34-
| User-group ID | A unique Adobe-assigned number used to identify a user-group. For examples, `46842488`|
35-
| <a name="usergroupAdmin" class="api-ref-subtitle">User-group Administrator</a> | A user role in an organization. Administers assigned user-group descriptions, managing all associated administrative functions, such as adding and removing users from groups. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
14+
| Term | Meaning |
15+
|:-----------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
16+
| Access Token | {% include_relative partials/authorizationDescription.md %} |
17+
| <a name="adminconsole" class="api-ref-subtitle">Admin Console</a> | A central location for managing your Adobe entitlements across your entire organization, available at https://adminconsole.adobe.com/enterprise. |
18+
| <a name="adobeId" class="api-ref-subtitle">AdobeID</a> | An Identity Type that is created, owned, and managed by the end user. Adobe performs authentication, and the end user manages the identity. Users retain complete control over files and data associated with their ID. See full discussion at [Identity Types](https://helpx.adobe.com/enterprise/help/identity.html). |
19+
| API Key | {% include_relative partials/apiKeyDescription.md %} |
20+
| <a name="deployment" class="api-ref-subtitle">Deployment Administrator</a> | Creates, manages, and deploys software packages and updates to end users. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
21+
| <a name="developer" class="api-ref-subtitle">Developer</a> | Users given this role for a specific product profile are considered to be a developer for that product profile. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
22+
| <a name="enterpriseId" class="api-ref-subtitle">Enterprise ID</a> | An Identity Type that is created, owned, and managed by an organization. Adobe hosts the Enterprise ID and performs authentication, but the organization maintains the Enterprise ID. End-users cannot sign up and create an Enterprise ID, nor can they sign up for additional products and services from Adobe using an Enterprise ID. See full discussion at [Identity Types](https://helpx.adobe.com/enterprise/help/identity.html). |
23+
| <a name="federatedId" class="api-ref-subtitle">Federated ID</a> | An Identity Type that is created and owned by an organization, and linked to the enterprise directory through federation. The organization manages credentials and processes Single Sign-On through a SAML2 identity provider. UMAPI clients with email-federated domains must always identity users by email. See full discussion at [Identity Types](https://helpx.adobe.com/enterprise/help/identity.html). |
24+
| <a name="unknownUserType" class="api-ref-subtitle">usertype `unknown`</a> | In some cases a userType may contain the value `unknown`. In these cases the user may not contain the necessary values to identify the user type. |
25+
| Group type | The group type is returned in user-group API responses. User-groups are always of type `USER_GROUP` |
26+
| <a name="identity" class="api-ref-subtitle">Identity Types</a> | The [Identity Types](https://helpx.adobe.com/enterprise/help/identity.html) resource explains the different account types that are available: Adobe, Enterprise, and Federated IDs. |
27+
| Organization ID | {% include_relative partials/orgIdDescription.md %} |
28+
| <a name="productAdmin" class="api-ref-subtitle">Product Administrator</a> | A user role in an organization. A user with this role (an admin) administers the assigned products, managing all associated administrative functions, such as creating product profiles and adding users and user-groups to the organization. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
29+
| <a name="productProfile" class="api-ref-subtitle">Product Profile</a> | A set of specific entitlements and roles for a product, defined in the Admin Console. Users and user groups can belong to product profiles. |
30+
| <a name="productProfileAdmin" class="api-ref-subtitle">Product Profile Administrator</a> | A user role in an organization. A user with this role administers assigned Product Profile descriptions, managing all associated administrative functions, such as adding and removing users from Product Profiles. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
31+
| <a name="orgAdmin" class="api-ref-subtitle">System Administrator</a> | A user role in an organization. A "super user" for the organization who is allowed to perform all administrative tasks, including the capabilities granted to User Group admin, Product admin, Product Profile admin, Support admin and Deployment admin. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
32+
| <a name="supportAdmin" class="api-ref-subtitle">Support Administrator</a> | See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
33+
| <a name="usergroup" class="api-ref-subtitle">User Group</a> | A group of loosely associated users. Typically used to organize a set of related users by department or function. For example: `U.S.FinanceOperations`, `EU Human Resources` |
34+
| User-group ID | A unique Adobe-assigned number used to identify a user-group. For examples, `46842488` |
35+
| <a name="usergroupAdmin" class="api-ref-subtitle">User-group Administrator</a> | A user role in an organization. Administers assigned user-group descriptions, managing all associated administrative functions, such as adding and removing users from groups. See full discussion at [Administrative Roles](https://helpx.adobe.com/enterprise/using/admin-roles.html#). |
36+
| <a name="sharedUserGroup" class="api-ref-subtitle">Shared User Group</a> | In the Global Admin Console, Shared user groups allows you to use a single user management source to sync user groups and the associated users to multiple Admin Consoles. Further information available at [Share User Groups](https://www.adobe.com/go/user_group_share) |
3637
{:.bordertablestyle}

0 commit comments

Comments
 (0)