summaryrefslogtreecommitdiffstats
path: root/auth-client/src/main/xsd/aaf_oauth2.xsd
blob: 22283184712fc8ba02b6f591dc619ed9383cf1c7 (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
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
<!-- 
 * ============LICENSE_START====================================================
 * org.onap.aaf
 * ===========================================================================
 * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
 * ===========================================================================
 * 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.
 * ============LICENSE_END====================================================
 *
-->
<xs:schema 
	xmlns:xs="http://www.w3.org/2001/XMLSchema" 
	xmlns:aafoauth="urn:aafoauth:v2_0"
	targetNamespace="urn:aafoauth:v2_0" 
	elementFormDefault="qualified">
	
	
	<!-- Definition of a GUID found several places on WEB, 5/24/2017
	Developed a HexToken instead 
	<xs:simpleType name="guid">
  		<xs:annotation>
	    	<xs:documentation xml:lang="en">
		       The representation of a GUID, generally the id of an element.
		    </xs:documentation>
	  	</xs:annotation>
	  	<xs:restriction base="xs:string">
	    	<xs:pattern value="\{[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}\}"/>
	  </xs:restriction>
	</xs:simpleType>
	-->

	<!--  fill this out 
	<xs:simpleType name="scope">
  		<xs:annotation>
	    	<xs:documentation xml:lang="en">
		       The representation of a GUID, generally the id of an element.
		    </xs:documentation>
	  	</xs:annotation>
	  	<xs:restriction base="xs:string">
	    	<xs:pattern value="[&#x|&#x23-&#x5B|&#5D-&#x7E]*"/>
	  </xs:restriction>
	</xs:simpleType>
	-->
	
	<!--
		Authenticate:  consider "redirect" as well as typical connection info like:
			grant_type - use the value “password”
			client_id - your API client id
			client_secret - the secret key of your client
			username - the account username for which you want to obtain an access token
			password - the account password
			response_type - use the value “token”
		 
	 -->
	<!--  RFC 6749, Section 4.2.1 -->
	<xs:element name="tokenRequest">
		<xs:complexType>
			<xs:sequence>
				<!-- Must be set to "token" -->
				<xs:element name="response_type" type="xs:string" minOccurs="1" maxOccurs="1"/>
				<xs:element name="client_id" type="xs:string" minOccurs="1" maxOccurs="1"/>
				<xs:element name="redirect_uri" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<!-- only include for "refresh_token" type -->
				<xs:element name="refresh_token" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<xs:element name="state" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<xs:element name="scope" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<!-- Normally put in application/x-www-form-urlencoded  -->
				<xs:element name="grant_type" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<xs:element name="username" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<xs:element name="password" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<xs:element name="client_secret" type="xs:string" minOccurs="0" maxOccurs="1"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
	 
	<!--  RFC 6749, Section 4.2.2 -->
	<xs:element name="token">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="access_token" type="xs:string" minOccurs="1" maxOccurs="1"/>
				<xs:element name="token_type" type="xs:string" minOccurs="1" maxOccurs="1"/>
				<xs:element name="refresh_token" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<xs:element name="expires_in" type="xs:int" minOccurs="0" maxOccurs="1"/>
				<xs:element name="scope" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<xs:element name="state" type="xs:string" minOccurs="0" maxOccurs="1"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>

	<!-- RFC 6749, Section  4.2.2.1 -->
	<xs:element name="error">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="error">
					<xs:simpleType>
						<xs:restriction base="xs:string">
							<xs:enumeration value="invalid_request" />
							<xs:enumeration value="unauthorized_client" />
							<xs:enumeration value="access_denied" />
							<xs:enumeration value="unsupported_response_type" />
							<xs:enumeration value="invalid_scope" />
							<xs:enumeration value="server_error" />
							<xs:enumeration value="temporarily_unavailable" /> 
						</xs:restriction>
					</xs:simpleType>
				</xs:element>
				<xs:element name="error_description" type="xs:string" minOccurs="0" maxOccurs="1" />
				<xs:element name="error_uri" type="xs:string" minOccurs="0" maxOccurs="1" />
				<xs:element name="state" type="xs:string" minOccurs = "0" maxOccurs="1" />
			</xs:sequence>
		</xs:complexType>
	</xs:element>

	<!-- Jonathan 4/21/2016 New for Certificate Info  -->
	<xs:element name="introspect">
		<xs:complexType>
			<xs:sequence>
				<xs:element name="access_token" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<xs:element name="active" type="xs:boolean" minOccurs="1" maxOccurs="1"/>
				<xs:element name="client_id" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<xs:element name="username" type="xs:string" minOccurs="0" maxOccurs="1"/>
				<xs:element name="client_type" type="xs:string" minOccurs="1" maxOccurs="1"/>
				<!-- Seconds from jan 1 1970 -->
				<xs:element name="exp" type="xs:long" minOccurs="0" maxOccurs="1"/>
				<xs:element name="scope" type="xs:string" minOccurs="1" maxOccurs="1"/>
				<xs:element name="content" type="xs:string" minOccurs="0" maxOccurs="1"/>
			</xs:sequence>
		</xs:complexType>
	</xs:element>
		
</xs:schema>