The Swagger Security Scheme object

The Security Scheme object provides a means to define a security scheme for use by the various REST API operations. Guidewire supports the following schemes:

Basic authentication
API key (either as a header or as a query parameter)
OAuth2 common flows, which are implicit, password, application, and access code

Required properties

Property	Type	Description	Combination style
`type`	`string`	Required. Documentation only. Value must be one of the following: `apiKey` `basic` `oauth2`	N/A

Optional properties

Property	Type	Description	Combination style
`description`	`string`	Documentation only.	N/A

Conditional properties

Property	Type	Description	Combination style
`authorizationUrl`	`string`	Required if all of the following are true: `type` is `oauth2` `flow` is either `implicit` or `accessCode` Documentation only. Do not use unless all the listed conditions are `true`.	N/A
`flow`	`string`	Required if `type` is `oauth2`. Documentation only. Use only if `type` is `oauth2`. Otherwise, do not use. The value must be one of the following: `accessCode` `application` `implicit` `password`	N/A
`in`	`string`	Required if `type` is `apiKey`. Documentation only. Use only if `type` is `apiKey`. Otherwise, do not use. If used, the value must be one of the following: `header` `query`	N/A
`name`	`string`	Required if `type` is `apiKey`. Documentation only. Use only if `type` is `apiKey`. Otherwise, do not use.	N/A
`scopes`	`map<string1, string2>`	Required if `type` is `oauth2`. Documentation only. Use only if `type` is `oauth2`. Otherwise, do not use.	N/A
`tokenUrl`	`string`	Required if all of the following are true: `type` is `oauth2` `flow` is either `accessCode` or `application` or `password` Documentation only. Do not use unless all the listed conditions are `true`.	N/A