74af136478
An Identity Provider (IdP) should be mapped to a domain. This patch updates the documentation and creates a release note recommending the domain_id parameter. Depends-On: Id18b8b2fe853b97631bc990df8188ed64a6e1275 Partial-Bug: #1642687 Change-Id: I1cb749371175169662dbb5fa8feafe403fb1c39b
107 lines
1.8 KiB
YAML
107 lines
1.8 KiB
YAML
# variables in header
|
|
|
|
# variables in path
|
|
|
|
id_path:
|
|
description: |
|
|
The Identity Provider ID
|
|
in: path
|
|
required: true
|
|
type: string
|
|
|
|
protocol_id:
|
|
description: |
|
|
The federation protocol ID
|
|
in: path
|
|
required: true
|
|
type: string
|
|
|
|
# variables in query
|
|
|
|
enabled_query:
|
|
description: |
|
|
Filter for Identity Providers' enabled attribute
|
|
in: query
|
|
required: false
|
|
type: bool
|
|
|
|
id_query:
|
|
description: |
|
|
Filter for Identity Providers' ID attribute
|
|
in: query
|
|
type: string
|
|
|
|
# variables in body
|
|
|
|
description:
|
|
description: |
|
|
The Identity Provider description
|
|
in: body
|
|
required: false
|
|
type: string
|
|
|
|
domain_id:
|
|
description: |
|
|
The ID of a domain that is associated with the Identity Provider. Federated
|
|
users that authenticate with the Identity Provider will be created under
|
|
the domain specified.
|
|
in: body
|
|
required: true
|
|
type: string
|
|
|
|
enabled:
|
|
description: |
|
|
Whether the Identity Provider is enabled or not
|
|
in: body
|
|
required: true
|
|
type: bool
|
|
|
|
id_body:
|
|
description: |
|
|
The Identity Provider unique ID
|
|
in: body
|
|
required: true
|
|
type: string
|
|
|
|
identity_providers:
|
|
description: |
|
|
List of Identity Providers
|
|
in: body
|
|
required: true
|
|
type: array
|
|
|
|
links:
|
|
description: |
|
|
Links containing URI to the Identity Provider resource and its Protocols
|
|
in: body
|
|
required: true
|
|
type: object
|
|
|
|
protocol:
|
|
description: |
|
|
The Federation Protocol object
|
|
in: body
|
|
required: true
|
|
type: object
|
|
|
|
protocols:
|
|
description: |
|
|
List of Federation Protocols
|
|
in: body
|
|
required: true
|
|
type: array
|
|
|
|
protocols_links:
|
|
description: |
|
|
Link containing the URI to the collection of Federation Protocols
|
|
in: body
|
|
required: true
|
|
type: object
|
|
|
|
remote_ids:
|
|
description: |
|
|
List of the unique Identity Provider's remote IDs
|
|
in: body
|
|
required: true
|
|
type: array
|