Create group (POST /v3/groups)

Creates a group.

If a multi-region user executes this API, a 403 error occurs.

A certain period of time is required for the synchronization of an added group with other regions in use.

Request headers

Content-type

Indicates the format of content defined in the MIME specification.

Specify application/json. (required)

Data type Cardinality
xsd:string 1..1

Accept

Indicates the accept format defined in the MIME specification.

Specify application/json. (optional)

Data type Cardinality
xsd:string 1..1

X-Auth-Token

Valid authentication token

Data type Cardinality
xsd:string 1..1

Request parameters

group

group object (required)

Data type Cardinality Parent element Child element
Element 1..1 None description

domain_id

name

description

Description of group

Input value
  • Up to 255 characters
Data type Cardinality Parent element Child element
xsd:string 0..1 group None

domain_id

Domain ID (required)

If omitted, the default domain is input.

Data type Cardinality Parent element Child element
xsd:string 1..1 group None

name

Group name (required)

Data type Cardinality Parent element Child element
xsd:string 1..1 group None

Response headers

HTTP status code

Returns the HTTP status code of the request.

One of the following values will be returned.

201:
Normal completion
400:
The request format is incorrect.

For example, a required parameter has not been specified.

401:
The token is invalid.
403:
Authority to execute the requested action not possessed.
404:
The specified domain_id was not found.
500:
An internal error occurred.
504:
The processing was not completed within a certain period of time.
Data type Cardinality
int 1..1

Response elements

group

group object

Data type Cardinality Parent element Child element
Element 1..1 None description

domain_id

id

links

name

description

Description of group

Data type Cardinality Parent element Child element
xsd:string 1..1 group None

domain_id

Domain ID

Data type Cardinality Parent element Child element
xsd:string 1..1 group None

id

ID of the group

Data type Cardinality Parent element Child element
xsd:string 1..1 group None

links

Link information of group

Data type Cardinality Parent element Child element
Element 1..1 group self

name

Group name

Data type Cardinality Parent element Child element
xsd:string 1..1 group None

Example of request


       {
    "group": {
        "description": " Developers cleared for work on secret projects",
        "domain_id": "--domain-id--",
        "name": " Secure Developers"
    }
}

Example of response


       {
    "group": {
        "description": "Developers cleared for work on secret projects",
        "domain_id": "--domain-id--",
        "id": "--group-id--",
        "links": {
            "self": "http://identity.gls.cloud.global.fujitsu.com/v3/groups/--group-id--"
        },
        "name": "Secure Developers"
    }
}