{ "opencollection": "1.0.0", "info": { "name": "Visier Administration User Groups V2 API", "version": "22222222.99201.3040" }, "request": { "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "header" } }, "items": [ { "info": { "name": "UserGroupsV2", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of user groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/admin/user-groups", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" }, { "name": "NonVersioned", "value": "" } ], "params": [ { "name": "with", "value": "", "type": "query", "description": "Controls the amount of detail to return in the response. Omit to return basic information.\n * **permissions**: Include the user group's permissions.\n * **users**: Include the users in the user group.\n * **details**: Include all available information." }, { "name": "limit", "value": "", "type": "query", "description": "The number of results to return. The maximum number of user groups to retrieve is 1000. The default is 100." }, { "name": "start", "value": "", "type": "query", "description": "The index to start retrieving results from, also known as offset. The index begins at 0." }, { "name": "displayNameFilter", "value": "", "type": "query", "description": "The display name filter to narrow the set of user groups to return. This filter must be defined using glob syntax with the following wildcards and is case-sensitive. The value in parentheses is the equivalent hex code, which is used when URL-encoding the filter string:\n - `'*'` (`%2A`) matches any sequence of characters.\n - `'?'` (`%3F`) matches a single character.\n - `' '` (`%20`) matches a space character.\n \n Example: \n - `Sales*` matches any user group that starts with \"Sales\".\n - `* ?egional * Office` is expressed as `%2A%20%3Fegional%20%2A%20Office` and can have many matches, such as \"Western Regional Support Office\"." }, { "name": "correlationIds", "value": "", "type": "query", "description": "If defined, `correlationIds` limits the response to the user groups associated with the specified correlation IDs.\n You can specify multiple correlation IDs in the `correlationIds` parameter separated by commas; for example, `correlationIds=123,abc,456`.\n\n **Note**:\n - Correlation IDs must be between 3 and 64 characters long and may only contain alphanumeric characters, underscores and hyphens.\n - Correlation IDs have a lifetime of up to 7 days after creation. After a correlation ID expires, you can only retrieve specific user groups using the user group ID.\n - Correlation IDs are optional during user group creation and are only applicable to those objects created with a defined correlation ID." } ] }, "docs": "Retrieve a collection of user groups. Use `with` to control the amount of detail returned in the response.\n `with` supports these values:\n * **permissions**: Include the user group's permissions.\n * **users**: Include the users in the user group.\n * **details**: Include all available information.\n\n This API can return a maximum of 1000 user groups. The default number of user groups to return is 100.\n\n To specify the project in which to return user groups, provide a project UUID in the `ProjectID" }, { "info": { "name": "Create multiple user groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/admin/user-groups", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" }, { "name": "NonVersioned", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create new user groups. To specify the tenant in which to add new user groups, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header.\n\n To specify the project in which to create new user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body." }, { "info": { "name": "Update multiple user groups", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/admin/user-groups", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" }, { "name": "NonVersioned", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update existing user groups. To specify the tenant in which to update a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each user group in the request body.\n\n When updating user groups, the user group definition in your API call replaces the prior definition. You must provide the entire definition in the `PUT` call. If you omit values from the update request, those values are removed from the user group. We recomme" }, { "info": { "name": "Patch multiple user groups", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/admin/user-groups", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" }, { "name": "NonVersioned", "value": "" }, { "name": "Prefer", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Make partial changes to user groups. To specify the tenant in which to patch a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header or `tenantCode` for each user group in the request body.\n\n Unlike `PUT`, which completely replaces the user group definition, use `PATCH` to change specific fields in the user group without affecting omitted fields.\n\n To specify the project in which to patch user groups, provide a project UUID in the `ProjectI" }, { "info": { "name": "Delete multiple user groups", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/admin/user-groups", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" }, { "name": "NonVersioned", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete user groups in bulk. To specify the tenant in which to delete user groups, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header.\n\n To specify the project in which to delete user groups, provide a project UUID in the `ProjectID` request header or `projectId` for each user group in the request body." }, { "info": { "name": "Revert user groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/admin/user-groups/revert-to-parent", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" }, { "name": "NonVersioned", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Revert a user group to its parent version. For example, if you revert a:\n - Tenant override object: The object reverts to the Blueprint version or, for administrating tenants who revert an analytic tenant's object, the administrating tenant's object version.\n - Tenant object: The API request fails. The object is unique to your tenant and no parent version exists.\n - Blueprint object: Nothing happens. The object is inherited from the parent and there is nothing to revert on this tenant." }, { "info": { "name": "Retrieve the details of a user group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/admin/user-groups/:userGroupId", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" }, { "name": "NonVersioned", "value": "" } ], "params": [ { "name": "userGroupId", "value": "", "type": "path", "description": "The ID of user group." }, { "name": "with", "value": "", "type": "query", "description": "Controls the amount of detail to return in the response. Omit to return detailed information.\n * **permissions**: Include the user group's permissions.\n * **users**: Include the users in the user group.\n * **details**: Include all available information." } ] }, "docs": "Retrieve all available information about a specific user group.\n \n
To specify the tenant in which to retrieve a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header.\n\n To specify the project in which to return a user group, provide a project UUID in the `ProjectID` request header." }, { "info": { "name": "Delete a user group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/admin/user-groups/:userGroupId", "headers": [ { "name": "TargetTenantID", "value": "" }, { "name": "ProjectID", "value": "" }, { "name": "NonVersioned", "value": "" } ], "params": [ { "name": "userGroupId", "value": "", "type": "path", "description": "The ID of user group to delete." } ] }, "docs": "Delete a specific user group. To specify the tenant in which to delete a user group, administrating tenants can provide an analytic tenant code in the `TargetTenantID` request header.\n\n To specify the project in which to delete a user group, provide a project UUID in the `ProjectID` request header." } ] } ], "bundled": true }