# Copyright 2018 New Vector Ltd
# Copyright 2019 The Matrix.org Foundation C.I.C.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
type: object
title: OpenIdCredentials
properties:
  access_token:
    type: string
    description: |-
      An access token the consumer may use to verify the identity of
      the person who generated the token. This is given to the federation
      API `GET /openid/userinfo` to verify the user's identity.
  token_type:
    type: string
    description: The string `Bearer`.
  matrix_server_name:
    type: string
    description: |-
      The homeserver domain the consumer should use when attempting to
      verify the user's identity.
  expires_in:
    type: integer
    description: |-
      The number of seconds before this token expires and a new one must
      be generated.
required: ['access_token', 'token_type', 'matrix_server_name', 'expires_in']
