arazzo: 1.0.1
info:
  title: UiPath Provision a Credential Asset
  summary: Create a credential asset and confirm it by reading it back.
  description: >-
    A secrets-provisioning pattern for Orchestrator. The workflow creates a
    Credential asset that stores a username and password pair for use by
    unattended automations, then reads the asset back by its returned ID to
    confirm the non-secret metadata persisted. The password field is write-only,
    so only the username and definition are verified on read. Every step spells
    out its request inline so the flow can be read and executed without opening
    the underlying OpenAPI description.
  version: 1.0.0
sourceDescriptions:
- name: orchestratorApi
  url: ../openapi/uipath-orchestrator-openapi.yml
  type: openapi
workflows:
- workflowId: provision-credential-asset
  summary: Create a Credential asset then read it back to confirm.
  description: >-
    Creates a Credential asset with a username and password, then retrieves it by
    ID to confirm its definition.
  inputs:
    type: object
    required:
    - folderId
    - assetName
    - username
    - password
    properties:
      folderId:
        type: integer
        description: Numeric folder ID used as the organization unit context.
      assetName:
        type: string
        description: Display name for the credential asset.
      username:
        type: string
        description: Username portion stored in the credential asset.
      password:
        type: string
        description: Password portion stored in the credential asset (write-only).
      description:
        type: string
        description: Optional description of the credential asset's purpose.
  steps:
  - stepId: createCredential
    description: >-
      Create a Credential asset in the folder storing the supplied username and
      password pair.
    operationId: createAsset
    parameters:
    - name: X-UIPATH-OrganizationUnitId
      in: header
      value: $inputs.folderId
    requestBody:
      contentType: application/json
      payload:
        Name: $inputs.assetName
        ValueType: Credential
        CredentialUsername: $inputs.username
        CredentialPassword: $inputs.password
        Description: $inputs.description
    successCriteria:
    - condition: $statusCode == 201
    outputs:
      assetId: $response.body#/Id
      valueType: $response.body#/ValueType
  - stepId: confirmCredential
    description: >-
      Read the credential asset back by its ID to confirm its name, type, and
      username persisted. The password is write-only and is not returned.
    operationId: getAsset
    parameters:
    - name: key
      in: path
      value: $steps.createCredential.outputs.assetId
    - name: X-UIPATH-OrganizationUnitId
      in: header
      value: $inputs.folderId
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      confirmedName: $response.body#/Name
      confirmedUsername: $response.body#/CredentialUsername
      confirmedType: $response.body#/ValueType
  outputs:
    assetId: $steps.createCredential.outputs.assetId
    confirmedUsername: $steps.confirmCredential.outputs.confirmedUsername
    confirmedType: $steps.confirmCredential.outputs.confirmedType