AuthProvider.php — ShareThis Dashboard for Google Analytics trunk

googleanalytics / lib / analytics-admin / vendor / google / common-protos / src / Api / AuthProvider.php

googleanalytics / lib / analytics-admin / vendor / google / common-protos / src / Api Last commit date

AuthProvider.php

301 lines

1	<?php
2	# Generated by the protocol buffer compiler. DO NOT EDIT!
3	# source: google/api/auth.proto
4
5	namespace Google\Api;
6
7	use Google\Protobuf\Internal\GPBType;
8	use Google\Protobuf\Internal\RepeatedField;
9	use Google\Protobuf\Internal\GPBUtil;
10
11	/**
12	* Configuration for an anthentication provider, including support for
13	* [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
14	*
15	* Generated from protobuf message <code>google.api.AuthProvider</code>
16	*/
17	class AuthProvider extends \Google\Protobuf\Internal\Message
18	{
19	/**
20	* The unique identifier of the auth provider. It will be referred to by
21	* `AuthRequirement.provider_id`.
22	* Example: "bookstore_auth".
23	*
24	* Generated from protobuf field <code>string id = 1;</code>
25	*/
26	private $id = '';
27	/**
28	* Identifies the principal that issued the JWT. See
29	* https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
30	* Usually a URL or an email address.
31	* Example: https://securetoken.google.com
32	* Example: 1234567-compute@developer.gserviceaccount.com
33	*
34	* Generated from protobuf field <code>string issuer = 2;</code>
35	*/
36	private $issuer = '';
37	/**
38	* URL of the provider's public key set to validate signature of the JWT. See
39	* [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
40	* Optional if the key set document:
41	* - can be retrieved from
42	* [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
43	* of the issuer.
44	* - can be inferred from the email domain of the issuer (e.g. a Google service account).
45	* Example: https://www.googleapis.com/oauth2/v1/certs
46	*
47	* Generated from protobuf field <code>string jwks_uri = 3;</code>
48	*/
49	private $jwks_uri = '';
50	/**
51	* The list of JWT
52	* [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
53	* that are allowed to access. A JWT containing any of these audiences will
54	* be accepted. When this setting is absent, only JWTs with audience
55	* "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
56	* will be accepted. For example, if no audiences are in the setting,
57	* LibraryService API will only accept JWTs with the following audience
58	* "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
59	* Example:
60	* audiences: bookstore_android.apps.googleusercontent.com,
61	* bookstore_web.apps.googleusercontent.com
62	*
63	* Generated from protobuf field <code>string audiences = 4;</code>
64	*/
65	private $audiences = '';
66	/**
67	* Redirect URL if JWT token is required but no present or is expired.
68	* Implement authorizationUrl of securityDefinitions in OpenAPI spec.
69	*
70	* Generated from protobuf field <code>string authorization_url = 5;</code>
71	*/
72	private $authorization_url = '';
73
74	/**
75	* Constructor.
76	*
77	* @param array $data {
78	* Optional. Data for populating the Message object.
79	*
80	* @type string $id
81	* The unique identifier of the auth provider. It will be referred to by
82	* `AuthRequirement.provider_id`.
83	* Example: "bookstore_auth".
84	* @type string $issuer
85	* Identifies the principal that issued the JWT. See
86	* https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
87	* Usually a URL or an email address.
88	* Example: https://securetoken.google.com
89	* Example: 1234567-compute@developer.gserviceaccount.com
90	* @type string $jwks_uri
91	* URL of the provider's public key set to validate signature of the JWT. See
92	* [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
93	* Optional if the key set document:
94	* - can be retrieved from
95	* [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
96	* of the issuer.
97	* - can be inferred from the email domain of the issuer (e.g. a Google service account).
98	* Example: https://www.googleapis.com/oauth2/v1/certs
99	* @type string $audiences
100	* The list of JWT
101	* [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
102	* that are allowed to access. A JWT containing any of these audiences will
103	* be accepted. When this setting is absent, only JWTs with audience
104	* "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
105	* will be accepted. For example, if no audiences are in the setting,
106	* LibraryService API will only accept JWTs with the following audience
107	* "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
108	* Example:
109	* audiences: bookstore_android.apps.googleusercontent.com,
110	* bookstore_web.apps.googleusercontent.com
111	* @type string $authorization_url
112	* Redirect URL if JWT token is required but no present or is expired.
113	* Implement authorizationUrl of securityDefinitions in OpenAPI spec.
114	* }
115	*/
116	public function __construct($data = NULL) {
117	\GPBMetadata\Google\Api\Auth::initOnce();
118	parent::__construct($data);
119	}
120
121	/**
122	* The unique identifier of the auth provider. It will be referred to by
123	* `AuthRequirement.provider_id`.
124	* Example: "bookstore_auth".
125	*
126	* Generated from protobuf field <code>string id = 1;</code>
127	* @return string
128	*/
129	public function getId()
130	{
131	return $this->id;
132	}
133
134	/**
135	* The unique identifier of the auth provider. It will be referred to by
136	* `AuthRequirement.provider_id`.
137	* Example: "bookstore_auth".
138	*
139	* Generated from protobuf field <code>string id = 1;</code>
140	* @param string $var
141	* @return $this
142	*/
143	public function setId($var)
144	{
145	GPBUtil::checkString($var, True);
146	$this->id = $var;
147
148	return $this;
149	}
150
151	/**
152	* Identifies the principal that issued the JWT. See
153	* https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
154	* Usually a URL or an email address.
155	* Example: https://securetoken.google.com
156	* Example: 1234567-compute@developer.gserviceaccount.com
157	*
158	* Generated from protobuf field <code>string issuer = 2;</code>
159	* @return string
160	*/
161	public function getIssuer()
162	{
163	return $this->issuer;
164	}
165
166	/**
167	* Identifies the principal that issued the JWT. See
168	* https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
169	* Usually a URL or an email address.
170	* Example: https://securetoken.google.com
171	* Example: 1234567-compute@developer.gserviceaccount.com
172	*
173	* Generated from protobuf field <code>string issuer = 2;</code>
174	* @param string $var
175	* @return $this
176	*/
177	public function setIssuer($var)
178	{
179	GPBUtil::checkString($var, True);
180	$this->issuer = $var;
181
182	return $this;
183	}
184
185	/**
186	* URL of the provider's public key set to validate signature of the JWT. See
187	* [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
188	* Optional if the key set document:
189	* - can be retrieved from
190	* [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
191	* of the issuer.
192	* - can be inferred from the email domain of the issuer (e.g. a Google service account).
193	* Example: https://www.googleapis.com/oauth2/v1/certs
194	*
195	* Generated from protobuf field <code>string jwks_uri = 3;</code>
196	* @return string
197	*/
198	public function getJwksUri()
199	{
200	return $this->jwks_uri;
201	}
202
203	/**
204	* URL of the provider's public key set to validate signature of the JWT. See
205	* [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
206	* Optional if the key set document:
207	* - can be retrieved from
208	* [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html
209	* of the issuer.
210	* - can be inferred from the email domain of the issuer (e.g. a Google service account).
211	* Example: https://www.googleapis.com/oauth2/v1/certs
212	*
213	* Generated from protobuf field <code>string jwks_uri = 3;</code>
214	* @param string $var
215	* @return $this
216	*/
217	public function setJwksUri($var)
218	{
219	GPBUtil::checkString($var, True);
220	$this->jwks_uri = $var;
221
222	return $this;
223	}
224
225	/**
226	* The list of JWT
227	* [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
228	* that are allowed to access. A JWT containing any of these audiences will
229	* be accepted. When this setting is absent, only JWTs with audience
230	* "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
231	* will be accepted. For example, if no audiences are in the setting,
232	* LibraryService API will only accept JWTs with the following audience
233	* "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
234	* Example:
235	* audiences: bookstore_android.apps.googleusercontent.com,
236	* bookstore_web.apps.googleusercontent.com
237	*
238	* Generated from protobuf field <code>string audiences = 4;</code>
239	* @return string
240	*/
241	public function getAudiences()
242	{
243	return $this->audiences;
244	}
245
246	/**
247	* The list of JWT
248	* [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
249	* that are allowed to access. A JWT containing any of these audiences will
250	* be accepted. When this setting is absent, only JWTs with audience
251	* "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
252	* will be accepted. For example, if no audiences are in the setting,
253	* LibraryService API will only accept JWTs with the following audience
254	* "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
255	* Example:
256	* audiences: bookstore_android.apps.googleusercontent.com,
257	* bookstore_web.apps.googleusercontent.com
258	*
259	* Generated from protobuf field <code>string audiences = 4;</code>
260	* @param string $var
261	* @return $this
262	*/
263	public function setAudiences($var)
264	{
265	GPBUtil::checkString($var, True);
266	$this->audiences = $var;
267
268	return $this;
269	}
270
271	/**
272	* Redirect URL if JWT token is required but no present or is expired.
273	* Implement authorizationUrl of securityDefinitions in OpenAPI spec.
274	*
275	* Generated from protobuf field <code>string authorization_url = 5;</code>
276	* @return string
277	*/
278	public function getAuthorizationUrl()
279	{
280	return $this->authorization_url;
281	}
282
283	/**
284	* Redirect URL if JWT token is required but no present or is expired.
285	* Implement authorizationUrl of securityDefinitions in OpenAPI spec.
286	*
287	* Generated from protobuf field <code>string authorization_url = 5;</code>
288	* @param string $var
289	* @return $this
290	*/
291	public function setAuthorizationUrl($var)
292	{
293	GPBUtil::checkString($var, True);
294	$this->authorization_url = $var;
295
296	return $this;
297	}
298
299	}
300
301