---
title: "OPTIONS /Ams/Authenticate/{Token}"
method: OPTIONS
path: "/Ams/Authenticate/{Token}"
tags: ["Ams"]
---

# OPTIONS /Ams/Authenticate/{Token}

`OPTIONS /Ams/Authenticate/{Token}`

## Request

- Base URL: `https://ws.yourmembership.com`
- URL: `https://ws.yourmembership.com/Ams/Authenticate/{Token}`
- Auth: none declared. Required headers: `Accept`
- TypeScript: <https://skmtc.dev/yourmembership/apis/ym-rest-services/docs/Ams/Authenticate/:Token/options.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `Token` string, required

## Query parameters

- `ConsumerKey` string
- `ConsumerSecret` string
- `AccessToken` string
- `ClientID` integer
- `UserType` 'Anonymous' | 'Admin' | 'Member'
- `Username` string
- `Password` string
- `EmailAddress` string
- `IncludeMemberConfig` boolean
- `IncludeExchangeToken` boolean
- `IncludeBrandingConfig` boolean
- `Device` 'Desktop' | 'IOS' | 'Android'

## Response `200`

Success

- AuthResponse: AuthResponse
  - `ClientID` integer
  - `MemberID` integer
  - `FailedLoginReason` 'None' | 'MultipleAccounts' | 'InvalidCredentials' | 'AccountLockedOut' | 'AccountSuspended' | 'AccountPendingApproval' | 'InvalidClient' | 'InvalidToken' | 'ConsentRequired'
  - `MemberConfig` MemberConfigResponse: MemberConfigResponse
    - `Locale` string
    - `DateFormat` string
    - `CurrencyDecimalSeparator` string
    - `CurrencyGroupSeparator` string
    - `CurrencySymbol` string
    - `CurrencyPositivePattern` string
    - `CurrencyNegativePattern` string
    - `SiteUrl` string
    - `CareersID` integer
    - `ClientNameMobile` string
    - `FullName` string
    - `SecureUrl` string
    - `QuickLinksCount` integer
    - `MemberID` integer
    - `ClientID` integer
    - `ResponseStatus` ResponseStatus: ResponseStatus
      - `ErrorCode` string
      - `Message` string
      - `StackTrace` string
      - `Errors` ResponseError[]
        - `ErrorCode` string
        - `FieldName` string
        - `Message` string
        - `Meta` DictionaryStringString: Dictionary<String,String>
      - `Meta` DictionaryStringString: Dictionary<String,String>
    - `BypassCache` boolean
    - `DateCached` string, date-time
    - `Device` string
  - `BrandingConfig` BrandingConfigResponse: BrandingConfigResponse
    - `Options` DictionaryStringString: Dictionary<String,String>
    - `UsingRedis` boolean
    - `AppInitTime` string, date-time
    - `ServerID` string
    - `ClientID` integer
    - `ResponseStatus` ResponseStatus: ResponseStatus
      - `ErrorCode` string
      - `Message` string
      - `StackTrace` string
      - `Errors` ResponseError[]
        - `ErrorCode` string
        - `FieldName` string
        - `Message` string
        - `Meta` DictionaryStringString: Dictionary<String,String>
      - `Meta` DictionaryStringString: Dictionary<String,String>
    - `BypassCache` boolean
    - `DateCached` string, date-time
    - `Device` string
  - `ExchangeToken` string
  - `UserId` string
  - `SessionId` string
  - `UserName` string
  - `DisplayName` string
  - `ReferrerUrl` string
  - `BearerToken` string
  - `RefreshToken` string
  - `ResponseStatus` ResponseStatus: ResponseStatus
    - `ErrorCode` string
    - `Message` string
    - `StackTrace` string
    - `Errors` ResponseError[]
      - `ErrorCode` string
      - `FieldName` string
      - `Message` string
      - `Meta` DictionaryStringString: Dictionary<String,String>
    - `Meta` DictionaryStringString: Dictionary<String,String>
  - `Meta` DictionaryStringString: Dictionary<String,String>

---

[API](https://skmtc.dev/yourmembership/apis/ym-rest-services.md) - [All operations](https://skmtc.dev/yourmembership/apis/ym-rest-services/llms.txt) - [OpenAPI document](https://skmtc.dev/yourmembership/apis/ym-rest-services/revisions/8d8a2e7e7d56?raw)