Retrieve a user group under an organization
GET /organizations/{organization_id}/usergroups/{usergroup_id}
Retrieves a user group under the specified organization.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
organization_id |
string |
path |
True |
ID of the organization
|
usergroup_id |
string |
path |
True |
ID of the user group
|
Response
Status: 200, Returns the stored user group in the JSON response body if it belongs to the organization
Name | Type | Required | Description |
---|---|---|---|
description |
string |
False |
JSON string containing the description of the user group. Defined values are: * Minimum length: 1 * Maximum length: 254 * This string is internally validated to prevent XSS, Unicode, directory traversal, and SQL-injection attacks. |
id |
string |
True |
Globally unique identifier of the resource. Defined values are:
|
isSystem |
string |
False |
Specifies if an object is system generated. Defined values are:
|
links |
array[type_bxp_link] |
False |
|
metadata |
False |
Metadata associated with the resource |
|
name |
string |
True |
JSON string containing a name for the user group. Defined values are:
|
ownerOrganizationId |
string |
True |
JSON string containing the ID of the organization. |
tags |
array[tags] |
False |
JSON array of tags (name/value pairs) representing metadata for the user group. |
type |
string |
True |
Media type of the resource. Defined values are:
|
version |
string |
True |
Version of the resource. Defined values are:
|
Example response
{
"description": "This tag represents NetApp Sales Territory",
"id": "666a3f38-d4fa-5b62-a391-a69029758d32",
"metadata": {
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269",
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"labels": [],
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"modifiedBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
},
"name": "AcmeUsers",
"ownerOrganizationId": "6544af09-8036-51e4-b579-bd30cb07b269",
"tags": [
{
"internal:bxp:organizationId": "36d4cc43-0b0f-4363-b922-eed1d80f8ea6"
}
],
"type": "application/vnd.netapp.bxp.usergroup",
"version": "1.0"
}
Error
Status: 404, Not found
Name | Type | Required | Description |
---|---|---|---|
correlationId |
string |
False |
Internal UUID representing the request or related trace ID |
detail |
string |
False |
Details about the problem |
invalidParams |
array[invalidParams] |
False |
List of invalid parameters |
status |
string |
True |
HTTP error code related to the problem |
title |
string |
True |
Title description of the problem |
type |
string |
True |
Content-type of this object |
Example error response
{
"detail": "The collection specified in the request URI wasn't found.",
"status": "404",
"title": "Collection not found",
"type": "https://bluexp.netapp.io/problems/2"
}
Definitions
See Definitions
accept-post
Provides details about which media types are accepted when creating a resource.
accept-put
Provides details about which media types are accepted when updating a resource.
hints
Name | Type | Required | Description |
---|---|---|---|
accept-post |
False |
Provides details about which media types are accepted when creating a resource. |
|
accept-put |
False |
Provides details about which media types are accepted when updating a resource. |
|
allow |
array[string] |
False |
An array of methods that can be used to interact with the link target. Defined values for collections: "POST" - Indicates if new resources can be created in the collection. Defined values for resources: "PUT" - Indicates if the resource can be modified "DELETE" - Indicates if the resource can be deleted |
permissions |
array[string] |
False |
List of the permissions required to use the link. |
status |
string |
False |
Indicates if the target of the link is deprecated. Defined values are: "deprecated" |
targetSchema
Link to a JSON schema that can be used to validate the target of the link (response body).
The preferred format is a $ref link to an external schema.
This field is optional and should only be included when there is a known schema for the target of the href.
See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details.
type_bxp_link
Link relationship
Name | Type | Required | Description |
---|---|---|---|
hints |
False |
||
href |
string |
True |
String describing a relative URI. |
rel |
string |
True |
The type of relationship for the link. Values are defined in the IANA Link Relationships registry, or an extension relationship type as specified in section 2.1.2 of RFC 8288. |
targetSchema |
False |
Link to a JSON schema that can be used to validate the target of the link (response body). The preferred format is a $ref link to an external schema. This field is optional and should only be included when there is a known schema for the target of the href. See https://json-schema.org/draft/2019-09/json-schema-hypermedia.html#rfc.section.9.2 for more details. |
|
title |
string |
False |
Label of a link so that it can be used as a human-readable identifier (for example, a menu entry). Minimum length: 0 Maximum length: 1023 |
type |
string |
False |
The media type of the target of the href. This field is optional and should be included when there is a known media type for the target of the href. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/link for more details. |
type_bxp_label
Name/value pair
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
|
value |
string |
True |
type_bxp_metadata
Metadata associated with the resource
Name | Type | Required | Description |
---|---|---|---|
createdBy |
string |
False |
UUID of the user who created the resource. |
creationTimestamp |
string |
False |
Resource creation date |
labels |
array[type_bxp_label] |
False |
Array of name/value pairs representing additional information for the resource. |
modificationTimestamp |
string |
False |
Resource modification date. |
modifiedBy |
string |
False |
UUID of the user who modified the resource. |
invalidParams
Name | Type | Required | Description |
---|---|---|---|
name |
string |
True |
Name of the invalid parameter |
reason |
string |
True |
Reason why the parameter is invalid |