---
title: "Get the authentication options for a given provider"
method: GET
path: "/api/v1/provider-authentication-options/{providerName}"
tags: ["Connectivity v1.Provider", "BETA"]
---

# Get the authentication options for a given provider

`GET /api/v1/provider-authentication-options/{providerName}`

(DEPRECATED) Retrieves the available authentication options for a provider if it has more than one available.

DEPRECATED: This endpoint is deprecated and will be removed. End-of-life: 31 December 2026 23:59:59 UTC.

## Path parameters

- `providerName` string, required

## Response `200`

A successful response.

- GetAuthenticationOptionsResponse
  - `authenticationOptionsGroups` AuthenticationOptionsGroup[]
    - `authenticationOptions` AuthenticationOption[] — List of available authentication options in this group.
      - `default` boolean — Indicates if this is the default authentication option, in case none is selected.
      - `displayText` string — A short description of how this authentication option will affect the authentication flow.
      - `fields` Field[] — List of fields that are necessary to be filled if this authentication option is selected.
        - `additionalInfo` string — A serialized JSON containing additional information that could be useful.
        - `checkbox` boolean — Display boolean value as checkbox.
        - `description` string — A short description of what the field is used for.
        - `group` string — Identifies which fields should be gathered in the group.
        - `helpText` string — Text displayed next to the input field.
        - `hint` string — Gray text in the input view (Similar to a placeholder).
        - `immutable` boolean — Controls whether or not the field values entered are immutable.
        - `masked` boolean — Controls whether or not the field should be shown masked, like a password field.
        - `maxLength` integer — Integer value of the maximum accepted characters of input.
        - `minLength` integer — Integer value of the minimum accepted characters of input.
        - `name` string — The name of the input field.
        - `numeric` boolean — Controls whether or not the field should only accept numeric values.
        - `oneOf` boolean — Identifies if only one field within group should be filled.
        - `optional` boolean — Controls whether or not the field should be optional.
        - `pattern` string — A regex pattern that can be evaluated on the input.
        - `patternError` string — An error message that can be displayed if the provided pattern does not validate.
        - `selectOptions` SelectOption[] — A list of options where the user should select one.
          - `iconUrl` string — A URL the client can optionally use to show an icon to represent the option.
          - `text` string — The human-readable description of this option to display to the user.
          - `value` string — The machine-readable value to send if the user picks this option.
        - `sensitive` boolean — Controls whether or not the field should be sensitive.
        - `style` string — Information about style of 2FA screen.
        - `type` string — Stores information about field type.
        - `value` string
      - `helpText` string — Help text with extra information about the implications of choosing this authentication option.
      - `name` string — Unique name of authentication option.
      - `supportedChannels` SupportedChannel[] — Supported channels where this authentication option can be selected.
    - `displayText` string — A short description of what the authentication option group is used for.
    - `helpText` string — Help text with extra information about what the authentication option group is intended for.
    - `name` string — Unique name of authentication options group.
  - `providerName` string

## Other responses

- `401` — Authorization token is missing, or not valid
- `403` — You are not allowed to access the requested resource
- `default` — An unexpected error response.

---

[API](https://skmtc.net/tink/apis/tink-api.md) · [All operations](https://skmtc.net/tink/apis/tink-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tink/tink-api/revisions/23d8982b533d/schema)