Authentication

GET /api/authentication

Provides the details of the enabled authentication providers.

Response

200 — The requested Authentication Information

• AnyAuthenticationProvidersSupportPasswordManagement boolean
• ApiKeyDefaultExpiryDays integer
• ApiKeyMaxExpiryDays integer
• AuthenticationProviders array of object
  • CSSLinks array of string
  • DisplayName string
  • FormsLoginEnabled boolean
  • IdentityType enum
    Allowed values: Guest, UsernamePassword, ActiveDirectory, OAuth.
  • JavascriptLinks array of string
  • Links object
  • Name string
• AutoLoginEnabled boolean
• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• OctopusIdDynamicRegistrationPending boolean
• RememberMeEnabled boolean
• UserApiKeysEnabled boolean

{
  "AnyAuthenticationProvidersSupportPasswordManagement": true,
  "ApiKeyDefaultExpiryDays": 0,
  "ApiKeyMaxExpiryDays": 0,
  "AuthenticationProviders": [
    {
      "CSSLinks": [
        "string"
      ],
      "DisplayName": "string",
      "FormsLoginEnabled": true,
      "IdentityType": "Guest",
      "JavascriptLinks": [
        "string"
      ],
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string"
    }
  ],
  "AutoLoginEnabled": true,
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "OctopusIdDynamicRegistrationPending": true,
  "RememberMeEnabled": true,
  "UserApiKeysEnabled": true
}

POST /api/authentication/checklogininitiated

Request Body

• EncodedQueryString string (required)
  Minimum length 1.

Response

200 — Whether the external server has initiated login and if so the provider’s name

• Id string
  Gets or sets a unique identifier for this resource.
• LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
• LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
• Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
• ProviderName string
• WasLoginInitiated boolean

{
  "EncodedQueryString": "string"
}

{
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "ProviderName": "string",
  "WasLoginInitiated": true
}