doc-exports/docs/iam/api-ref/en-us_topic_0057845618.html

Querying User Group Details

Function

This API is used to query detailed information about a user group.

URI

• URI format

  GET /v3/groups/{group_id}

• Query parameters

  Parameter	Mandatory	Type	Description
  group_id	Yes	String	ID of a user group.

Request Parameters

• Parameters in the request header

  Parameter	Mandatory	Type	Description
  Content-Type	Yes	String	Fill application/json;charset=utf8 in this field.
  X-Auth-Token	Yes	String	Authenticated token with the Security Administrator permission.

• Example request

  curl -i -k -H "X-Auth-Token:$token" -H 'Content-Type:application/json;charset=utf8' -X GET https://sample.domain.com/v3/groups/ab9f261180d746ef8624beb5ae39b5aa

Response Parameters

• Parameters in the response body

  Parameter	Type	Description
  group	JSON object	Response body of a user group.

• group

  Parameter	Type	Description
  description	String	User group description.
  domain_id	String	ID of the domain to which a user group belongs.
  id	String	User group ID.
  links	JSONObject	Links to a user group.
  name	String	User group name.
  create_time	Long	Time when the user group was created.

• group.links

  Parameter	Type	Description
  self	String	Resource link.
  previous	String	Previous resource link. If the previous resource link is unavailable, this parameter is set to null.
  next	String	Next resource link. If the next resource link is unavailable, this parameter is set to null.

• Example response

  {
      "group":{
          "domain_id":"d54061ebcb5145dd814f8eb3fe9b7ac0",
          "description":"Contract developers",
          "id":"ab9f261180d746ef8624beb5ae39b5aa",
          "links":{
              "self":"https://sample.domain.com/v3/groups/ab9f261180d746ef8624beb5ae39b5aa"
          },
          "name":"abcdef",
          "create_time": 1494943784468
      }
  }

Status Codes

Status Code	Description
200	The request is successful.
400	The server failed to process the request.
401	Authentication failed.
403	Access denied.
404	The requested resource cannot be found.

Parent topic: User Group Management