← Back to branch summary

~ubuntu-branches/ubuntu/saucy/keystone/saucy-proposed

« back to all changes in this revision

Viewing changes to keystone/content/admin/xsd/token.xsd

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2011-08-23 10:18:22 UTC
  • Revision ID: james.westby@ubuntu.com-20110823101822-enve6zceb3lqhuvj
Tags: upstream-1.0~d4~20110823.1078
Import upstream version 1.0~d4~20110823.1078

Show diffs side-by-side

added added

removed removed

Lines of Context:
keystone/content/admin/xsd/token.xsd
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<?xml-stylesheet type="text/xsl" href="../xslt/schema.xslt"?>
 
3
 
 
4
<!-- (C) 2011 OpenStack LLC., All Rights Reserved -->
 
5
 
 
6
<schema
 
7
    elementFormDefault="qualified"
 
8
    attributeFormDefault="unqualified"
 
9
    xmlns="http://www.w3.org/2001/XMLSchema"
 
10
    xmlns:identity="http://docs.openstack.org/identity/api/v2.0"
 
11
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 
12
    xmlns:vc="http://www.w3.org/2007/XMLSchema-versioning"
 
13
    xmlns:xsdxt="http://docs.rackspacecloud.com/xsd-ext/v1.0"
 
14
    xmlns:atom="http://www.w3.org/2005/Atom"
 
15
    targetNamespace="http://docs.openstack.org/identity/api/v2.0"
 
16
>
 
17
    <include schemaLocation="roles.xsd"/>
 
18
    <include schemaLocation="user.xsd"/>
 
19
    
 
20
    <!-- Elements -->
 
21
    <element name="access" type="identity:AuthenticateResponse"/>
 
22
    
 
23
    <!-- Complex Types -->
 
24
    <complexType name="Token">
 
25
        <annotation>
 
26
            <xsd:documentation xml:lang="EN" xmlns="http://www.w3.org/1999/xhtml">
 
27
                <p>
 
28
                    A token is an arbitrary bit of text that is used to access
 
29
                    resources. Each token has a scope which describes which
 
30
                    resources are accessible with it. A token may be
 
31
                    revoked at anytime and is valid for a finite duration.
 
32
                </p>
 
33
                <p>
 
34
                    While Keystone supports token-based authentication in this release,
 
35
                    the intention is for it to support additional protocols in the
 
36
                    future. The desire is for it to be an integration service, and not
 
37
                    a full-fledged identity store and management solution.
 
38
                </p>
 
39
            </xsd:documentation>
 
40
            <xsd:appinfo>
 
41
                <xsdxt:samples>
 
42
                    <xsdxt:sample>
 
43
                        <xsdxt:code type="application/xml" href="../samples/token.xml" />
 
44
                    </xsdxt:sample>
 
45
                    <xsdxt:sample>
 
46
                        <xsdxt:code type="application/json" href="../samples/token.json" />
 
47
                    </xsdxt:sample>
 
48
                </xsdxt:samples>
 
49
            </xsd:appinfo>
 
50
        </annotation>
 
51
        <sequence>
 
52
            <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" />
 
53
        </sequence>
 
54
        <attribute name="expires" type="xsd:dateTime" use="required"/>
 
55
        <attribute name="id" type="xsd:string" use="required"/>
 
56
        <anyAttribute namespace="##other" processContents="lax"/>
 
57
    </complexType>
 
58
 
 
59
    <complexType name="AuthenticateResponse">
 
60
        <sequence>
 
61
            <element name="token" type="identity:Token"/>
 
62
            <element name="user" type="identity:UserForAuthenticateResponse"/>
 
63
            <element name="serviceCatalog" type="identity:ServiceCatalog"/>
 
64
            <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" />
 
65
        </sequence>
 
66
        <anyAttribute namespace="##other" processContents="lax"/>
 
67
    </complexType>
 
68
    
 
69
    <complexType name="UserForAuthenticateResponse">
 
70
        <sequence>
 
71
            <element name="roles" type="identity:RoleList" />
 
72
            <any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded" />
 
73
        </sequence>
 
74
        <attribute name="username" type="xsd:string"/>
 
75
        <anyAttribute namespace="##other" processContents="lax"/>
 
76
    </complexType>
 
77
    <complexType name="ServiceCatalog">
 
78
        <annotation>
 
79
            <xsd:documentation xml:lang="EN" xmlns="http://www.w3.org/1999/xhtml">
 
80
                <p>
 
81
                  The service catalog lists the services you have access to
 
82
                </p>
 
83
                <div class="design">
 
84
                    <p>
 
85
                    We optimized for future flexibility around the hierarchy. So we
 
86
                    left the design as a flat list of endpoints with attributes and the
 
87
                    consumer can categorize as they need.
 
88
                    This results in potential duplication (such as with the version/@list)
 
89
                    but we acceopt that normalization cost in order to not force an
 
90
                    artificial hierarchy (suchas on region, which can be optional).
 
91
                  </p>
 
92
                </div>
 
93
            </xsd:documentation>
 
94
            <xsd:appinfo>
 
95
              <xsdxt:samples>
 
96
                <xsdxt:sample>
 
97
                  <xsdxt:code type="application/xml" href="../samples/services.xml" />
 
98
                </xsdxt:sample>
 
99
                <xsdxt:sample>
 
100
                  <xsdxt:code type="application/json" href="../samples/services.json" />
 
101
                </xsdxt:sample>
 
102
              </xsdxt:samples>
 
103
            </xsd:appinfo>
 
104
        </annotation>
 
105
        <sequence>
 
106
            <element name="service" type="identity:ServiceCategory" minOccurs="1" maxOccurs="unbounded">
 
107
                <annotation>
 
108
                    <xsd:documentation
 
109
                            xml:lang="EN"
 
110
                            xmlns="http://www.w3.org/1999/xhtml">
 
111
                        <p>
 
112
                            A list of services.
 
113
                        </p>
 
114
                    </xsd:documentation>
 
115
                </annotation>
 
116
            </element>
 
117
        </sequence>
 
118
        <anyAttribute namespace="##other" processContents="lax"/>
 
119
    </complexType>
 
120
    <complexType name="ServiceCategory">
 
121
        <sequence>
 
122
            <element name="endpoint" type="identity:EndpointForService" minOccurs="1" maxOccurs="unbounded">
 
123
                <annotation>
 
124
                    <xsd:documentation
 
125
                            xml:lang="EN"
 
126
                            xmlns="http://www.w3.org/1999/xhtml">
 
127
                        <p>
 
128
                            A list of endpoints.
 
129
                        </p>
 
130
                    </xsd:documentation>
 
131
                </annotation>
 
132
            </element>
 
133
        </sequence>
 
134
        <attribute name="type" type="xsd:string" use="required">
 
135
          <annotation>
 
136
                <xsd:documentation
 
137
                        xml:lang="EN"
 
138
                        xmlns="http://www.w3.org/1999/xhtml">
 
139
                    <p>
 
140
                        The OpenStack-registered type (e.g. 'compute', 'object-store', etc).
 
141
                    </p>
 
142
                </xsd:documentation>
 
143
            </annotation>
 
144
        </attribute>
 
145
        <attribute name="name" type="xsd:string" use="optional">
 
146
            <annotation>
 
147
                <xsd:documentation
 
148
                        xml:lang="EN"
 
149
                        xmlns="http://www.w3.org/1999/xhtml">
 
150
                    <p>
 
151
                        The commercial service name (e.g. 'My Nova Cloud Servers').
 
152
                    </p>
 
153
                </xsd:documentation>
 
154
            </annotation>
 
155
        </attribute>
 
156
        <anyAttribute namespace="##other" processContents="lax"/>
 
157
    </complexType>
 
158
    <complexType name="EndpointForService">
 
159
        <attribute name="region" type="xsd:string" use="optional">
 
160
            <annotation>
 
161
                <xsd:documentation
 
162
                        xml:lang="EN"
 
163
                        xmlns="http://www.w3.org/1999/xhtml">
 
164
                    <p>
 
165
                        The name of the region where the endpoint
 
166
                        lives. Example: airport codes; LHR (UK),
 
167
                        STL (Saint Louis)
 
168
                    </p>
 
169
                </xsd:documentation>
 
170
            </annotation>
 
171
        </attribute>
 
172
        <attribute name="publicURL" type="xsd:anyURI" use="required">
 
173
            <annotation>
 
174
                <xsd:documentation
 
175
                        xml:lang="EN"
 
176
                        xmlns="http://www.w3.org/1999/xhtml">
 
177
                    <p>
 
178
                        The publically accessible service URL.
 
179
                    </p>
 
180
                </xsd:documentation>
 
181
            </annotation>
 
182
        </attribute>
 
183
        <attribute name="internalURL" type="xsd:anyURI" use="optional">
 
184
            <annotation>
 
185
                <xsd:documentation
 
186
                        xml:lang="EN"
 
187
                        xmlns="http://www.w3.org/1999/xhtml">
 
188
                    <p>
 
189
                        A service URL, accessible only locally within that
 
190
                        cloud (generally over a high bandwidth, low latency,
 
191
                        free of charge link).
 
192
                    </p>
 
193
                </xsd:documentation>
 
194
            </annotation>
 
195
        </attribute>
 
196
        <attribute name="adminURL" type="xsd:anyURI" use="optional">
 
197
            <annotation>
 
198
                <xsd:documentation
 
199
                        xml:lang="EN"
 
200
                        xmlns="http://www.w3.org/1999/xhtml">
 
201
                    <p>
 
202
                        An Admin URL (used for administration using privileged
 
203
                        calls). This may expose
 
204
                        additional functionality not found in the public and
 
205
                        internal URL.
 
206
                    </p>
 
207
                </xsd:documentation>
 
208
            </annotation>
 
209
        </attribute>
 
210
        <anyAttribute namespace="##other" processContents="lax"/>
 
211
    </complexType>
 
212
</schema>
 
213