Class: Azure::ApiManagement::Mgmt::V2017_03_01::Models::AuthorizationServerContract

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb

Overview

External OAuth authorization server settings.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#authorization_endpoint ⇒ String

tools.ietf.org/html/rfc6749#section-3.2.

Returns:

  • (String) —

    OAuth authorization endpoint. See



78
79
80
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 78

def authorization_endpoint
  @authorization_endpoint
end

#authorization_methods ⇒ Array<AuthorizationMethod>

authorization endpoint. GET must be always present. POST is optional.

Returns:



21
22
23
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 21

def authorization_methods
  @authorization_methods
end

#bearer_token_sending_methods ⇒ Array<BearerTokenSendingMethod>

which access token is passed to the API.

Returns:



52
53
54
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 52

def bearer_token_sending_methods
  @bearer_token_sending_methods
end

#client_authentication_method ⇒ Array<ClientAuthenticationMethod>

supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.

Returns:



28
29
30
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 28

def client_authentication_method
  @client_authentication_method
end

#client_id ⇒ String

server.

Returns:

  • (String) —

    Client or app id registered with this authorization



86
87
88
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 86

def client_id
  @client_id
end

#client_registration_endpoint ⇒ String

registration for this authorization server is performed. Contains absolute URL to entity being referenced.

Returns:

  • (String) —

    Optional reference to a page where client or app



74
75
76
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 74

def client_registration_endpoint
  @client_registration_endpoint
end

#client_secret ⇒ String

authorization server.

Returns:

  • (String) —

    Client or app secret registered with this



56
57
58
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 56

def client_secret
  @client_secret
end

#default_scope ⇒ String

default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.

Returns:

  • (String) —

    Access token scope that is going to be requested by



48
49
50
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 48

def default_scope
  @default_scope
end

#description ⇒ String

HTML formatting tags.

Returns:

  • (String) —

    Description of the authorization server. Can contain



17
18
19
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 17

def description
  @description
end

#display_name ⇒ String

Returns User-friendly authorization server name.

Returns:

  • (String) —

    User-friendly authorization server name.



69
70
71
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 69

def display_name
  @display_name
end

#grant_types ⇒ Array<GrantType>

client uses to request the access token.

Returns:

  • (Array<GrantType>) —

    Form of an authorization grant, which the



82
83
84
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 82

def grant_types
  @grant_types
end

#resource_owner_password ⇒ String

password grant type is supported by this authorization server. Default resource owner password.

Returns:

  • (String) —

    Can be optionally specified when resource owner



66
67
68
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 66

def resource_owner_password
  @resource_owner_password
end

#resource_owner_username ⇒ String

password grant type is supported by this authorization server. Default resource owner username.

Returns:

  • (String) —

    Can be optionally specified when resource owner



61
62
63
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 61

def resource_owner_username
  @resource_owner_username
end

#support_state ⇒ Boolean

parameter from the authorization request to its response. Client may use state parameter to raise protocol security.

Returns:

  • (Boolean) —

    If true, authorization server will include state



43
44
45
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 43

def support_state
  @support_state
end

#token_body_parameters ⇒ Array<TokenBodyParameterContract>

required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. : “name value”, “value”: “a value”.

Returns:



34
35
36
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 34

def token_body_parameters
  @token_body_parameters
end

#token_endpoint ⇒ String

being referenced.

Returns:

  • (String) —

    OAuth token endpoint. Contains absolute URI to entity



38
39
40
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 38

def token_endpoint
  @token_endpoint
end

Class Method Details

.mapper ⇒ Object

Mapper for AuthorizationServerContract class as Ruby Hash. This will be used for serialization/deserialization.



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/2017-03-01/generated/azure_mgmt_api_management/models/authorization_server_contract.rb', line 93

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'AuthorizationServerContract',
    type: {
      name: 'Composite',
      class_name: 'AuthorizationServerContract',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        authorization_methods: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.authorizationMethods',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AuthorizationMethodElementType',
                type: {
                  name: 'Enum',
                  module: 'AuthorizationMethod'
                }
            }
          }
        },
        client_authentication_method: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clientAuthenticationMethod',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ClientAuthenticationMethodElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        token_body_parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.tokenBodyParameters',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'TokenBodyParameterContractElementType',
                type: {
                  name: 'Composite',
                  class_name: 'TokenBodyParameterContract'
                }
            }
          }
        },
        token_endpoint: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.tokenEndpoint',
          type: {
            name: 'String'
          }
        },
        support_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.supportState',
          type: {
            name: 'Boolean'
          }
        },
        default_scope: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.defaultScope',
          type: {
            name: 'String'
          }
        },
        bearer_token_sending_methods: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.bearerTokenSendingMethods',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'BearerTokenSendingMethodElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        client_secret: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.clientSecret',
          type: {
            name: 'String'
          }
        },
        resource_owner_username: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.resourceOwnerUsername',
          type: {
            name: 'String'
          }
        },
        resource_owner_password: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.resourceOwnerPassword',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.displayName',
          constraints: {
            MaxLength: 50,
            MinLength: 1
          },
          type: {
            name: 'String'
          }
        },
        client_registration_endpoint: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.clientRegistrationEndpoint',
          type: {
            name: 'String'
          }
        },
        authorization_endpoint: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.authorizationEndpoint',
          type: {
            name: 'String'
          }
        },
        grant_types: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.grantTypes',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'GrantTypeElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        client_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.clientId',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end