schema.auth.oauthdef.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of serverlessworkflow-api Show documentation

Java SDK for Serverless Workflow Specification

There is a newer version: 7.0.0-alpha5.1

Show newest version

{
  "type": "object",
  "javaType": "io.serverlessworkflow.api.auth.OauthDefinition",
  "properties": {
    "authority": {
      "type": "string",
      "description": "String or a workflow expression. Contains the authority information",
      "minLength": 1
    },
    "grantType": {
      "type": "string",
      "description": "Defines the grant type",
      "enum": [
        "password",
        "clientCredentials",
        "tokenExchange"
      ],
      "additionalItems": false
    },
    "clientId": {
      "type": "string",
      "description": "String or a workflow expression. Contains the client identifier",
      "minLength": 1
    },
    "clientSecret": {
      "type": "string",
      "description": "Workflow secret or a workflow expression. Contains the client secret",
      "minLength": 1
    },
    "scopes": {
      "type": "array",
      "description": "Array containing strings or workflow expressions. Contains the OAuth2 scopes",
      "items": {
        "type": "string"
      },
      "minItems": 1
    },
    "username": {
      "type": "string",
      "description": "String or a workflow expression. Contains the user name. Used only if grantType is 'resourceOwner'",
      "minLength": 1
    },
    "password": {
      "type": "string",
      "description": "String or a workflow expression. Contains the user password. Used only if grantType is 'resourceOwner'",
      "minLength": 1
    },
    "audiences": {
      "type": "array",
      "description": "Array containing strings or workflow expressions. Contains the OAuth2 audiences",
      "items": {
        "type": "string"
      },
      "minItems": 1
    },
    "subjectToken": {
      "type": "string",
      "description": "String or a workflow expression. Contains the subject token",
      "minLength": 1
    },
    "requestedSubject": {
      "type": "string",
      "description": "String or a workflow expression. Contains the requested subject",
      "minLength": 1
    },
    "requestedIssuer": {
      "type": "string",
      "description": "String or a workflow expression. Contains the requested issuer",
      "minLength": 1
    },
    "metadata": {
      "$ref": "../metadata/metadata.json"
    }
  },
  "required": [
    "grantType",
    "clientId"
  ]
}