ジャンプ先

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

クライアントのクライアント証明書の追加

投稿

/oam/services/rest/ssa/api/v1/oauthpolicyadmin/clientartifacts

リクエスト

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

• application/json
• application/xml

本文()

クライアントのインポートする必要がある公開証明書

ルート・スキーマ: ClientArtifact

型: object

ソースを表示

• certificateValue: string
  公開証明書のBase64でエンコードされた値
• clientName: string
  証明書をインポートしているクライアントの名前
• identityDomainName: string
  クライアントが存在するアイデンティティ・ドメインの名前

{
    "type":"object",
    "required":[
        "identityDomainName",
        "clientName",
        "certificateValue"
    ],
    "properties":{
        "identityDomainName":{
            "type":"string",
            "description":"Name of the Identity Domain under which the Client exists"
        },
        "clientName":{
            "type":"string",
            "description":"Name of the Client under which the certificate is being imported"
        },
        "certificateValue":{
            "type":"string",
            "description":"Base64 Encoded value of the Public certificate"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

エンティティ - OAuthClientTrustArtifact、詳細を正常に作成しました

本文()

ルート・スキーマ: ClientResponse

型: object

ソースを表示

• attributes(optional): array attributes
• clientType(optional): string
  指定可能な値: [ "CONFIDENTIAL_CLIENT", "PUBLIC_CLIENT", "MOBILE_CLIENT" ]

  クライアントのタイプ
• description(optional): string
• grantTypes(optional): array grantTypes
• id(optional): string
  クライアントのClientID。指定されていない場合、自動生成されます
• idDomain(optional): string
  クライアントが存在するアイデンティティ・ドメインの名前
• name: string
  クライアントの名前
• redirectURIs(optional): array redirectURIs
• scopes(optional): array scopes
• secret(optional): string
  機密である場合のクライアントのパスワード

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Client"
        },
        "description":{
            "type":"string"
        },
        "idDomain":{
            "type":"string",
            "description":"Name of the Identity Domain under which the Client exists"
        },
        "id":{
            "type":"string",
            "description":"ClientID for the client. Will be auto generated if not specified"
        },
        "secret":{
            "type":"string",
            "description":"Password for the client if confidential"
        },
        "clientType":{
            "type":"string",
            "description":"Type of the client",
            "enum":[
                "CONFIDENTIAL_CLIENT",
                "PUBLIC_CLIENT",
                "MOBILE_CLIENT"
            ]
        },
        "grantTypes":{
            "type":"array",
            "xml":{
                "name":"grantTypes",
                "wrapped":true
            },
            "items":{
                "type":"string",
                "enum":[
                    "PASSWORD",
                    "REFRESH_TOKEN",
                    "JWT_BEARER",
                    "CLIENT_CREDENTIALS",
                    "AUTHORIZATION_CODE"
                ]
            }
        },
        "scopes":{
            "type":"array",
            "xml":{
                "name":"scopes",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/ScopeSettings"
            }
        },
        "redirectURIs":{
            "type":"array",
            "xml":{
                "name":"redirectURIs",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RedirectURI"
            }
        },
        "attributes":{
            "type":"array",
            "xml":{
                "name":"attributes",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/TokenAttributeSettings"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト TokenAttributeSettings
  アクセス・トークンに追加できるカスタム属性

{
    "type":"array",
    "xml":{
        "name":"attributes",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/TokenAttributeSettings"
    }
}

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

型: array

ソースを表示

• 配列: 文字列
  指定可能な値: [ "PASSWORD", "REFRESH_TOKEN", "JWT_BEARER", "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE" ]

{
    "type":"array",
    "xml":{
        "name":"grantTypes",
        "wrapped":true
    },
    "items":{
        "type":"string",
        "enum":[
            "PASSWORD",
            "REFRESH_TOKEN",
            "JWT_BEARER",
            "CLIENT_CREDENTIALS",
            "AUTHORIZATION_CODE"
        ]
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト RedirectURI

{
    "type":"array",
    "xml":{
        "name":"redirectURIs",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/RedirectURI"
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト ScopeSettings

{
    "type":"array",
    "xml":{
        "name":"scopes",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/ScopeSettings"
    }
}

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

型: object

アクセス・トークンに追加できるカスタム属性

ソースを表示

• attrName: string
  カスタム属性の名前
• attrType: string
  指定可能な値: [ "STATIC", "DYNAMIC" ]

  属性のタイプ
• attrValue: string
  カスタム属性の値。これは評価および置換される静的値または動的値になる可能性があります。

{
    "type":"object",
    "description":"Custom attributes that can be added to the Access Token",
    "required":[
        "attrName",
        "attrValue",
        "attrType"
    ],
    "properties":{
        "attrName":{
            "type":"string",
            "description":"Name of the custom attribute"
        },
        "attrValue":{
            "type":"string",
            "description":"Value of the custom attribute. This could be a static value or a dynamic one that is evaluated and substituted."
        },
        "attrType":{
            "type":"string",
            "description":"Type of the Attribute",
            "enum":[
                "STATIC",
                "DYNAMIC"
            ]
        }
    }
}

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

型: object

ソースを表示

• isHttps(optional): boolean
  デフォルト値: true
• url: string
  リダイレクトURL

{
    "type":"object",
    "required":[
        "url"
    ],
    "properties":{
        "url":{
            "type":"string",
            "description":"Redirect URL"
        },
        "isHttps":{
            "type":"boolean",
            "default":"true"
        }
    }
}

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

型: object

ソースを表示

• scopeName: string
  スコープの名前

{
    "type":"object",
    "required":[
        "scopeName"
    ],
    "properties":{
        "scopeName":{
            "type":"string",
            "description":"Name of the scope"
        }
    }
}

422 レスポンス

OAuthエンティティ"Client" - 名前"NameofClient"の変更に失敗しました

先頭に戻る