機械翻訳について

移動

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

ユーザーを検索します

get

{protocol}//{host}:{port}{basePath}/ic/api/fileserver/v1/users

すべてのユーザー、ファイル・サーバー用に構成されたユーザーまたはグループ名で検索

リクエスト

問合せパラメータ

• configuredUsersOnly(required): boolean
  すべてのユーザーの検索(false)または構成されたファイル・サーバー・ユーザーのみの検索

  デフォルト値: false
• searchCriteria(required): string
  searchCriteria

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

成功

本文()

ルート・スキーマ : schema

型: object

読取り専用: true

ユーザー検索結果を提供

Show Source

• users: array users

{
    "type":"object",
    "properties":{
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FileServerUser"
            }
        }
    },
    "description":"Provides user search result",
    "readOnly":true,
    "xml":{
        "name":"users"
    }
}

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

型: array

Show Source

• Array of: object userConfig
  ユーザー・ファイル・サーバー・メタデータを記述

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

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

型: object

ユーザー・ファイル・サーバー・メタデータを記述

Show Source

• effectiveHomeDirectory: string
  読取り専用: true

  コンピュートされたホーム/ランディング・フォルダ。 ホーム・タイプがnoneの場合、ユーザーはグループからホームを導出するため、homeDirectoryとは異なる場合があります。
• firstName: string
  読取り専用: true
• homeDirectory: string
  ホーム・ディレクトリまたはランディング・フォルダ。 homeTypeがなしでない場合のホーム・フォルダの絶対パス
• homeType: string
  許容値: [ "Default", "Custom", "None" ]

  ユーザーが所有するホーム・フォルダのタイプ。 デフォルトは/home/users/{username}です。 カスタムは、homeDirectoryで指定されたパスを使用することを意味します。 ユーザーのホーム・フォルダは作成されず、ランディング・フォルダはグループのメンバーシップによって決定されます。
• lastName: string
  読取り専用: true
• mailId: string
  読取り専用: true
• middleName: string
  読取り専用: true
• name: string
  読取り専用: true
• publicKeyConfigured: boolean
• status: string
  許容値: [ "not configured", "enabled", "disabled" ]

  ユーザー・ステータス。'disabled'ユーザーは、サーバーへのアクセスを禁止されている間、権限を設定できます。'not configured'ユーザーには、関連付けられた権限やその他のメタデータはありません。
• userGroups: array userGroups
  読取り専用: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        },
        "firstName":{
            "type":"string",
            "readOnly":true
        },
        "middleName":{
            "type":"string",
            "readOnly":true
        },
        "lastName":{
            "type":"string",
            "readOnly":true
        },
        "mailId":{
            "type":"string",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "description":"User's status. 'disabled' users can have permissions set while still being prevented from accessing the server.  'not configured' users will not have any associated permissions or other metadata.",
            "enum":[
                "not configured",
                "enabled",
                "disabled"
            ]
        },
        "homeType":{
            "type":"string",
            "description":"The type of home folder the user has.  'Default' is /home/users/{username}.  'Custom' means use the path specified by homeDirectory.  'None' menas there will not be a home folder created for the user and the landing folder willbe determined by thier group membership.",
            "enum":[
                "Default",
                "Custom",
                "None"
            ]
        },
        "homeDirectory":{
            "type":"string",
            "description":"Home directory or landing folder. Absolute path of the home folder when homeType is not 'None'",
            "nullable":true
        },
        "effectiveHomeDirectory":{
            "type":"string",
            "description":"Computed home/landing folder. It can be different from homeDirectory when home type is none as user will derive home from one its group.",
            "readOnly":true
        },
        "userGroups":{
            "type":"array",
            "readOnly":true,
            "items":{
                "type":"string",
                "readOnly":true
            }
        },
        "publicKeyConfigured":{
            "type":"boolean"
        }
    },
    "description":"describes user's fileserver metadata",
    "xml":{
        "name":"userConfig"
    }
}

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

型: array

読取り専用: true

Show Source

• Array of: string
  読取り専用: true

{
    "type":"array",
    "readOnly":true,
    "items":{
        "type":"string",
        "readOnly":true
    }
}

401レスポンス

ユーザーを取得する権限がありません

404レスポンス

サービスが見つかりません

500レスポンス

内部サーバー・エラー

トップに戻る