PlantUML OAuth2 configuration OAuth2 configuration

       

Edit in DokuwikiEdit in AsciidocEdit in Markdown

OAuth2 configuration

• see also
• Basic Auth configuration
• Token Auth configuration
• General URL authentication documentation

Edit in DokuwikiEdit in AsciidocEdit in Markdown

OAuth2 client credentials flow

{
  "name": "<name of the configuration>",
  "type": "oauth",
  "identifier": "<principal identifier>",
  "secret": "<principal secret>",
  "properties": {
    "grantType": "client_credentials",
    "accessTokenUri": "<URL to token access controler>",
    "scope": "<access scopes>"
  },
  "proxy": {
    "type": "<proxy type>",
    "address": "<proxy server address>",
    "port": "<proxy server port>"
  }
}

• name: required
• The name of the configuration and should be similar to the file name
• type: oauth required
• Defines an OAuth2 flow
• identifier: required
• Principal identifier name
• secret:
• Secret for the principal (not encrypted)
• properties.grantType: client_credentials required
• Defines the OAuth2 client credentials flow
• properties.accessTokenUri: required
• URI to the AuthServer token access controller. If PlantUML is configured to work with an allow-list, this controller URI must be added to the list (see also security configuration)
• properties.scope:
• Access tokens to request (e.g. read write)
• proxy:
• Optional proxy configuration (overrides system proxy settings)
• proxy.type: required (direct, socks, http)
• Proxy type definition.
• proxy.address: required
• Proxy server address (hostname, IP address)
• proxy.port:
• Proxy server port number

{
  "name": "curity-demo",
  "type": "oauth",
  "identifier": "demo-backend-client",
  "secret": "MJlO3binatD9jk1",
  "properties": {
    "grantType": "client_credentials",
    "scope": "read write",
    "accessTokenUri": "https://login-demo.curity.io/oauth/v2/oauth-token"
  }
}

Edit in DokuwikiEdit in AsciidocEdit in Markdown

OAuth2 resource owner password credentials flow

{
  "name": "<name of the configuration>",
  "type": "oauth",
  "identifier": "<principal identifier>",
  "secret": "<principal secret>",
  "properties": {
    "grantType": "password",
    "accessTokenUri": "<URL to token access controler>",
    "scope": "<access scopes>",
    "resourceOwner": {
      "identifier": "<resource owner name>",
      "secret": "<resource owner secret>"
    }
  },
  "proxy": {
    "type": "<proxy type>",
    "address": "<proxy server address>",
    "port": "<proxy server port>"
  }
}

• name: required
• The name of the configuration and should be similar to the file name
• type: oauth required
• Defines an OAuth2 flow
• identifier: required
• Principal identifier name
• secret:
• Secret for the principal (not encrypted)
• properties.grantType: password required
• Defines the OAuth2 resource owner password credentials flow
• properties.accessTokenUri: required
• URI to the AuthServer token access controller. If PlantUML is configured to work with an allow-list, this controller URI must be added to the list (see also security configuration)
• properties.scope:
• Access tokens to request (e.g. read write)
• properties.resourceOwner.identifier:
• Resource owner name, who requests the access
• properties.resourceOwner.secret:
• Resource owner password
• proxy:
• Optional proxy configuration (overrides system proxy settings)
• proxy.type: required (direct, socks, http)
• Proxy type definition.
• proxy.address: required
• Proxy server address (hostname, IP address)
• proxy.port:
• Proxy server port number

{
	"name": "oauth-example",
	"type": "oauth",
	"identifier": "demo-backend-client",
	"secret": "MJlO3binatD9jk1",
	"properties": {
		"grantType": "password",
		"scope": "read write",
		"accessTokenUri": "https://login-demo.curity.io/oauth/v2/oauth-token",
		"resourceOwner": {
			"identifier": "alice",
			"secret": "secret"
		}
	}
}