BFC API を使用する前に、認証セッションを作成する必要があります。 任意の BFC API バージョンのログイン リソースにユーザ名およびパスワードをポストして、セッションを作成します。 ユーザ名とパスワードが有効であれば、セッション ID が返されます。これは Authorization ヘッダ内の各 BFC API コールに渡す必要があります。 セッションはアクティビティがない状態で 30 分間有効です。 ヘッダ X-CA-FC-runningClock が含まれていて、値が true になっている場合を除き、BFC へのリクエストによってセッション タイムアウトがリセットされます。 これは BFC に自動ポーリング コールを行うクライアントの場合に役に立ちます。 クライアントはログアウト リソースにセッション ID をポストすることでセッションを終了できます。
POST BFC/1.0/login
Content-Type:application/json
ペイロードは、username と password という 2 つのフィールドを持つ JSON オブジェクトです。
username
ユーザ名にテナント資格がない場合は、コア テナントとみなされます。 現在、BFC で使用可能なテナントはコア テナントのみです。
例: joe (または core/joe)
password
ユーザのパスワード。
例: MyPassword
{"username":"joe","password":"MyPassword"}
返されるペイロードはセッション ID を表す JSON 文字列です。 例:
"2f9b84766cdacd376125c7d57aaf6aa7"
POST/BFC//logout
Content-Type:application/json
認証: セッション ID
セッション ID
Copyright © 2012 CA. All rights reserved. |
|