Skip to content

Commit 4f8367e

Browse files
committed
adding ability to pass in tokens for accessing inputs
1 parent 2609558 commit 4f8367e

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

openapi/workflow_execution_service.openapi.yaml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1138,6 +1138,9 @@ components:
11381138
last_modified:
11391139
type: string
11401140
description: Last modification time in ISO 8601 format
1141+
credential_id:
1142+
type: string
1143+
description: Reference to a credential ID defined in the 'credentials' section of the RunRequest. This credential will be used to authenticate and authorize access to this File or Directory resource.
11411144
description:
11421145
type: string
11431146
description: Human-readable parameter description
@@ -1238,6 +1241,17 @@ components:
12381241
OPTIONAL
12391242
12401243
Additional workflow files required for execution (e.g., imported workflows, subworkflows, or dependencies). Each entry specifies both the source URL and target file path for precise file placement.
1244+
credentials:
1245+
type: object
1246+
description: >-
1247+
OPTIONAL
1248+
1249+
Named credentials that can be referenced by input parameters that require authentication to access File or Directory resources. Each credential is identified by a unique key and can be referenced multiple times by different parameters to avoid duplicating large authentication tokens.
1250+
additionalProperties:
1251+
oneOf:
1252+
- $ref: '#/components/schemas/PassportCredential'
1253+
- $ref: '#/components/schemas/BearerTokenCredential'
1254+
- $ref: '#/components/schemas/ApiKeyCredential'
12411255
description: >-
12421256
To execute a workflow, send a run request including all the details needed to begin downloading
12431257
@@ -1581,6 +1595,59 @@ components:
15811595
page_token:
15821596
type: string
15831597
description: OPTIONAL Token to use to indicate where to start getting results.
1598+
PassportCredential:
1599+
title: PassportCredential
1600+
type: object
1601+
description: GA4GH passport-based credential for accessing restricted resources
1602+
properties:
1603+
type:
1604+
type: string
1605+
enum: ["passport"]
1606+
description: Credential type identifier
1607+
passport:
1608+
type: array
1609+
items:
1610+
type: string
1611+
format: jwt
1612+
description: Array of GA4GH passport JWTs for authentication and authorization
1613+
minItems: 1
1614+
required:
1615+
- type
1616+
- passport
1617+
BearerTokenCredential:
1618+
title: BearerTokenCredential
1619+
type: object
1620+
description: Bearer token credential for accessing resources
1621+
properties:
1622+
type:
1623+
type: string
1624+
enum: ["bearer_token"]
1625+
description: Credential type identifier
1626+
token:
1627+
type: string
1628+
description: Bearer token for authentication
1629+
required:
1630+
- type
1631+
- token
1632+
ApiKeyCredential:
1633+
title: ApiKeyCredential
1634+
type: object
1635+
description: API key credential for accessing resources
1636+
properties:
1637+
type:
1638+
type: string
1639+
enum: ["api_key"]
1640+
description: Credential type identifier
1641+
key:
1642+
type: string
1643+
description: API key for authentication
1644+
header_name:
1645+
type: string
1646+
description: Header name for the API key (defaults to X-API-Key if not specified)
1647+
default: "X-API-Key"
1648+
required:
1649+
- type
1650+
- key
15841651

15851652

15861653

0 commit comments

Comments
 (0)