移動

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

ユーザー・アクセスの取得

get

http://{host}:{port}/veridata/v1/services/admin/access

必要なロール: Administrator

ユーザー・アクセスの取得

リクエスト

この操作にはリクエスト・パラメータはありません。

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

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

アクセスは正常に取得されました。

本文()

ルート・スキーマ: schema

タイプ: array

ソースの表示

• 配列: object Access

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Access"
    },
    "example":[
        {
            "id":0,
            "name":"Admin",
            "description":"Admin",
            "createdAt":"2025-04-04T12:06:09.569Z",
            "modifiedAt":"2025-04-04T12:06:09.569Z"
        }
    ]
}

例:

[
    {
        "id":0,
        "name":"Admin",
        "description":"Admin",
        "createdAt":"2025-04-04T12:06:09.569Z",
        "modifiedAt":"2025-04-04T12:06:09.569Z"
    }
]

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

タイプ: object

ソースの表示

• createdAt: string (date-time)
• description: string
• id: integer (int64)
  ユーザー・グループID。
• modifiedAt: string (date-time)
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"user group ID.",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "createdAt":{
            "type":"string",
            "format":"date-time"
        },
        "modifiedAt":{
            "type":"string",
            "format":"date-time"
        }
    }
}

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"
}

先頭に戻る