aboutsummaryrefslogtreecommitdiff
path: root/plugins/VNLib.Plugins.Essentials.SocialOauth/src/IOAuthAccessState.cs
blob: 888cc028afe3aebbaf738adb8a49e68381dae984 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/*
* Copyright (c) 2022 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Essentials.SocialOauth
* File: IOAuthAccessState.cs 
*
* IOAuthAccessState.cs is part of VNLib.Plugins.Essentials.SocialOauth which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Essentials.SocialOauth is free software: you can redistribute it and/or modify 
* it under the terms of the GNU Affero General Public License as 
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Essentials.SocialOauth is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program.  If not, see https://www.gnu.org/licenses/.
*/

#nullable enable

namespace VNLib.Plugins.Essentials.SocialOauth
{
    /// <summary>
    /// An object that represents an OAuth2 access token in its 
    /// standard form.
    /// </summary>
    public interface IOAuthAccessState
    {
        /// <summary>
        /// The OAuth2 access token
        /// </summary>
        public string? Token { get; set; }
        /// <summary>
        /// Token grant scope
        /// </summary>
        string? Scope { get; set; }
        /// <summary>
        /// The OAuth2 token type, usually 'Bearer'
        /// </summary>
        string? Type { get; set; }
        /// <summary>
        /// Optional refresh token
        /// </summary>
        string? RefreshToken { get; set; }

        /// <summary>
        /// Optional ID OIDC token
        /// </summary>
        string? IdToken { get; set; }
    }
}