• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Keystone
  5. User Group Management
  6. Querying User Group Details

Querying User Group Details

Function Description

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

URI

  • URI format

    GET /v3/groups/{group_id}

  • Query parameter description

    Parameter

    Mandatory

    Type

    Description

    group_id

    Yes

    String

    ID of a user group.

Request

  • Request header parameter description

    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.

  • Sample request
    curl -i -k -H "X-Auth-Token:$token" -H 'Content-Type:application/json;charset=utf8' -X GET https://10.145.93.56:31943/v3/groups/ab9f261180d746ef8624beb5ae39b5aa

Response

  • Response body parameter description

    Parameter

    Mandatory

    Type

    Description

    group

    Yes

    JSONObject

    Response body of a user group.

    description

    Yes

    String

    Description for a user group.

    domain_id

    Yes

    String

    ID of the domain to which a user group belongs.

    id

    Yes

    String

    ID of a user group.

    links

    Yes

    JSONObject

    Links to a user group.

    name

    Yes

    String

    Name of a user group.

    create_time

    Yes

    Long

    Time when a user group is created.

  • Sample 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

You must enter a username and password to access the requested page.

403

You are forbidden to access the requested page.

404

The server could not find the requested page.