keystone/api-ref/source/v3-ext/federation/identity-provider/parameters.yaml

116 lines
2.1 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
authorization_ttl:
description: |
The length of validity in minutes for group memberships carried over
through mapping and persisted in the database. If left unset, the
default value configured in keystone will be used, if enabled.
in: body
required: false
type: integer
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