AuthLink
HTTP API schema
← HTTP API referenceView source specification ↗
AuthLink fields
- id
string The unique identifier for the auth link
pattern: "^port1/[^/]+/[^/]+/auth-links/[^/]+$"
- ownerId
string The owner ID of the auth link
- associatedPrincipalId
string The ID of the associated principal that the auth link is established against
- associatedSecrets
array<AuthLinkSecret> List of associated secrets that are relevant to the auth link
- ItemAuthLinkSecret
associatedSecrets[]: Reference AuthLinkSecret
- associatedPluginId
string The ID of the associated plugin
- statusAuthLinkStatus
status: Reference AuthLinkStatus
- authorizationVariantId
string The plugin authorization variant the link uses
- regionalizationId
string The plugin regionalization the link targets
- providerConfigurationAuthLinkProviderConfiguration
providerConfiguration: Reference AuthLinkProviderConfiguration
- etag
string The quoted strong entity tag of the auth link, for If-Match
readOnly: true
- readinessAuthLinkReadiness
readiness: Reference AuthLinkReadiness