odata-vocabularies/vocabularies/Org.OData.Authorization.V1.json at 0867919485149d8636d0b04b06c4ab0860fbd67d · oasis-tcs/odata-vocabularies · GitHub

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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
{
    "$Version": "4.0",
    "$Reference": {
        "https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Core.V1.json": {
            "$Include": [
                {
                    "$Namespace": "Org.OData.Core.V1",
                    "$Alias": "Core"
                }
            ]
        }
    },
    "Org.OData.Authorization.V1": {
        "$Alias": "Authorization",
        "@Core.Description": "The Authorization Vocabulary provides terms for describing authorization requirements of the service",
        "@Core.Links": [
            {
                "rel": "alternate",
                "href": "https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Authorization.V1.xml"
            },
            {
                "rel": "latest-version",
                "href": "https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Authorization.V1.json"
            },
            {
                "rel": "describedby",
                "href": "https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Authorization.V1.md"
            }
        ],
        "SecuritySchemes": {
            "$Kind": "Term",
            "$Collection": true,
            "$Type": "Authorization.SecurityScheme",
            "$AppliesTo": [
                "EntityContainer"
            ],
            "@Core.Description": "At least one of the specified security schemes are required to make a request against the service"
        },
        "SecurityScheme": {
            "$Kind": "ComplexType",
            "Authorization": {
                "$Type": "Authorization.SchemeName",
                "@Core.Description": "The name of a required authorization scheme"
            },
            "RequiredScopes": {
                "$Collection": true,
                "@Core.Description": "The names of scopes required from this authorization scheme"
            }
        },
        "Authorizations": {
            "$Kind": "Term",
            "$Collection": true,
            "$Type": "Authorization.Authorization",
            "$AppliesTo": [
                "EntityContainer"
            ],
            "@Core.Description": "Lists the methods supported by the service to authorize access"
        },
        "Authorization": {
            "$Kind": "ComplexType",
            "$Abstract": true,
            "@Core.Description": "Base type for all Authorization types",
            "Name": {
                "@Core.Description": "Name that can be used to reference the authorization scheme"
            },
            "Description": {
                "$Nullable": true,
                "@Core.Description": "Description of the authorization scheme"
            }
        },
        "OpenIDConnect": {
            "$Kind": "ComplexType",
            "$BaseType": "Authorization.Authorization",
            "IssuerUrl": {
                "@Core.Description": "Issuer location for the OpenID Provider. Configuration information can be obtained by appending `/.well-known/openid-configuration` to this Url.",
                "@Core.IsURL": true
            }
        },
        "Http": {
            "$Kind": "ComplexType",
            "$BaseType": "Authorization.Authorization",
            "Scheme": {
                "@Core.Description": "HTTP Authorization scheme to be used in the Authorization header, as per RFC7235"
            },
            "BearerFormat": {
                "$Nullable": true,
                "@Core.Description": "Format of the bearer token"
            }
        },
        "OAuthAuthorization": {
            "$Kind": "ComplexType",
            "$Abstract": true,
            "$BaseType": "Authorization.Authorization",
            "Scopes": {
                "$Collection": true,
                "$Type": "Authorization.AuthorizationScope",
                "@Core.Description": "Available scopes"
            },
            "RefreshUrl": {
                "$Nullable": true,
                "@Core.Description": "Refresh Url",
                "@Core.IsURL": true
            }
        },
        "OAuth2ClientCredentials": {
            "$Kind": "ComplexType",
            "$BaseType": "Authorization.OAuthAuthorization",
            "TokenUrl": {
                "@Core.Description": "Token Url",
                "@Core.IsURL": true
            }
        },
        "OAuth2Implicit": {
            "$Kind": "ComplexType",
            "$BaseType": "Authorization.OAuthAuthorization",
            "@Core.Description": "Security note: OAuth2 implicit grant is considered to be not secure and should not be used by clients, see [OAuth 2.0 Security Best Current Practice](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics.html#name-implicit-grant).",
            "AuthorizationUrl": {
                "@Core.Description": "Authorization URL",
                "@Core.IsURL": true
            }
        },
        "OAuth2Password": {
            "$Kind": "ComplexType",
            "$BaseType": "Authorization.OAuthAuthorization",
            "TokenUrl": {
                "@Core.Description": "Token Url",
                "@Core.IsURL": true
            }
        },
        "OAuth2AuthCode": {
            "$Kind": "ComplexType",
            "$BaseType": "Authorization.OAuthAuthorization",
            "AuthorizationUrl": {
                "@Core.Description": "Authorization URL",
                "@Core.IsURL": true
            },
            "TokenUrl": {
                "@Core.Description": "Token Url",
                "@Core.IsURL": true
            }
        },
        "AuthorizationScope": {
            "$Kind": "ComplexType",
            "Scope": {
                "@Core.Description": "Scope name"
            },
            "Grant": {
                "$Nullable": true,
                "@Core.Description": "Identity that has access to the scope or can grant access to the scope."
            },
            "Description": {
                "@Core.Description": "Description of the scope"
            }
        },
        "ApiKey": {
            "$Kind": "ComplexType",
            "$BaseType": "Authorization.Authorization",
            "KeyName": {
                "@Core.Description": "The name of the header or query parameter"
            },
            "Location": {
                "$Type": "Authorization.KeyLocation",
                "@Core.Description": "Whether the API Key is passed in the header or as a query option"
            }
        },
        "KeyLocation": {
            "$Kind": "EnumType",
            "Header": 0,
            "Header@Core.Description": "API Key is passed in the header",
            "QueryOption": 1,
            "QueryOption@Core.Description": "API Key is passed as a query option",
            "Cookie": 2,
            "Cookie@Core.Description": "API Key is passed as a cookie"
        },
        "SchemeName": {
            "$Kind": "TypeDefinition",
            "$UnderlyingType": "Edm.String",
            "@Core.Description": "The name of the authorization scheme."
        }
    }
}