移動

• リクエスト
• レスポンス

ユーザー・グループの取得

get

http://{host}:{port}/veridata/v1/services/admin/usergroups/{Id}

必要なロール: Administrator、CommandLineOperator

ユーザー・グループの取得

リクエスト

パス・パラメータ

• Id(必須): integer(int64)
  グループID

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200 レスポンス

グループ詳細が正常に取得されました

本文()

ルート・スキーマ: UserGroupDetails

タイプ: object

ソースの表示

• access: array access
• createdOn: string (date-time)
  パターン: YYYY-MM-DDTHH:mm:ss.sssZ

  例: 2024-02-03T10:15:30Z
• description: string
• id: integer (int64)
  ユーザー・グループID。
• isModifiable: string
• name: string
• users: array users

{
    "properties":{
        "id":{
            "type":"integer",
            "description":"user group ID.",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "isModifiable":{
            "type":"string"
        },
        "createdOn":{
            "type":"string",
            "format":"date-time",
            "pattern":"YYYY-MM-DDTHH:mm:ss.sssZ",
            "example":"2024-02-03T10:15:30Z"
        },
        "access":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AccessList"
            }
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ListUser"
            }
        }
    },
    "example":{
        "id":0,
        "name":"UserGroup1",
        "description":"group1",
        "isModifiable":"false",
        "createdOn":"2024-02-03T10:15:30Z",
        "access":[
            {
                "roleId":0,
                "name":"Admin",
                "description":"admin role"
            }
        ],
        "users":[
            {
                "userId":0,
                "name":"User1",
                "emailId":"[e-mail]",
                "description":"user1"
            }
        ]
    }
}

例:

{
    "id":0,
    "name":"UserGroup1",
    "description":"group1",
    "isModifiable":"false",
    "createdOn":"2024-02-03T10:15:30Z",
    "access":[
        {
            "roleId":0,
            "name":"Admin",
            "description":"admin role"
        }
    ],
    "users":[
        {
            "userId":0,
            "name":"User1",
            "emailId":"[e-mail]",
            "description":"user1"
        }
    ]
}

ネストされたスキーマ: access

タイプ: array

ソースの表示

• 配列: object AccessList

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AccessList"
    }
}

ネストされたスキーマ: users

タイプ: array

ソースの表示

• 配列: object ListUser

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ListUser"
    }
}

ネストされたスキーマ: AccessList

タイプ: object

ソースの表示

• description: string
• name: string
• roleId: integer (int64)
  ユーザー・グループID。

{
    "type":"object",
    "properties":{
        "roleId":{
            "type":"integer",
            "description":"user group ID.",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: ListUser

タイプ: object

すべて一致

ソースの表示

• object UserResponse
• object ListUser-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/UserResponse"
        },
        {
            "type":"object"
        }
    ],
    "type":"object"
}

ネストされたスキーマ: UserResponse

タイプ: object

ソースの表示

• description: string
• emailId: string
• name: string
• userId: integer

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "emailId":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: ListUser-allOf[1]

タイプ: object

400 レスポンス

不正なリクエスト。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

401 レスポンス

権限がありません。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

404 レスポンス

見つかりません。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

500 レスポンス

サーバー・エラー。

本文()

ルート・スキーマ: Error

タイプ: object

ソースの表示

• errCode: string
  Veridataのエラー・コード。
• errMsg: string
  Veridataのエラー・メッセージ。

{
    "type":"object",
    "properties":{
        "errCode":{
            "type":"string",
            "description":"Veridata Error Code."
        },
        "errMsg":{
            "type":"string",
            "description":"Veridata Error Message."
        }
    },
    "example":{
        "errCode":"OGGV-00001",
        "errMsg":"Error message"
    }
}

例:

{
    "errCode":"OGGV-00001",
    "errMsg":"Error message"
}

先頭に戻る