Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceWorkday
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

airbyte.SourceWorkday

Explore with Pulumi AI

airbyte logo
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
airbytehq/terraform-provider-airbyte

    SourceWorkday Resource

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceWorkday;
import com.pulumi.airbyte.SourceWorkdayArgs;
import com.pulumi.airbyte.inputs.SourceWorkdayConfigurationArgs;
import com.pulumi.airbyte.inputs.SourceWorkdayConfigurationCredentialsArgs;
import com.pulumi.airbyte.inputs.SourceWorkdayConfigurationCredentialsReportBasedStreamsArgs;
import com.pulumi.airbyte.inputs.SourceWorkdayConfigurationCredentialsRestapiStreamsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceWorkday = new SourceWorkday("mySourceWorkday", SourceWorkdayArgs.builder()
            .configuration(SourceWorkdayConfigurationArgs.builder()
                .credentials(SourceWorkdayConfigurationCredentialsArgs.builder()
                    .reportBasedStreams(SourceWorkdayConfigurationCredentialsReportBasedStreamsArgs.builder()
                        .password("...my_password...")
                        .reportIds("{ \"see\": \"documentation\" }")
                        .username("...my_username...")
                        .build())
                    .restapiStreams(SourceWorkdayConfigurationCredentialsRestapiStreamsArgs.builder()
                        .accessToken("...my_access_token...")
                        .startDate("2024-10-26T07:00:00.000Z")
                        .build())
                    .build())
                .host("...my_host...")
                .tenant_id("...my_tenant_id...")
                .build())
            .definitionId("caf3b67e-129c-4e9e-a530-2b6adcf4997d")
            .secretId("...my_secret_id...")
            .workspaceId("40a9f4d4-7bdd-4a7c-90bb-08fd63077df2")
            .build());

    }
}

    resources:
  mySourceWorkday:
    type: airbyte:SourceWorkday
    properties:
      configuration:
        credentials:
          reportBasedStreams:
            password: '...my_password...'
            reportIds:
              - '{ "see": "documentation" }'
            username: '...my_username...'
          restapiStreams:
            accessToken: '...my_access_token...'
            startDate: 2024-10-26T07:00:00.000Z
        host: '...my_host...'
        tenant_id: '...my_tenant_id...'
      definitionId: caf3b67e-129c-4e9e-a530-2b6adcf4997d
      secretId: '...my_secret_id...'
      workspaceId: 40a9f4d4-7bdd-4a7c-90bb-08fd63077df2

    Create SourceWorkday Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SourceWorkday(name: string, args: SourceWorkdayArgs, opts?: CustomResourceOptions);
    @overload
def SourceWorkday(resource_name: str,
                  args: SourceWorkdayArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def SourceWorkday(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[SourceWorkdayConfigurationArgs] = None,
                  workspace_id: Optional[str] = None,
                  definition_id: Optional[str] = None,
                  name: Optional[str] = None,
                  secret_id: Optional[str] = None)
    func NewSourceWorkday(ctx *Context, name string, args SourceWorkdayArgs, opts ...ResourceOption) (*SourceWorkday, error)
    public SourceWorkday(string name, SourceWorkdayArgs args, CustomResourceOptions? opts = null)
    public SourceWorkday(String name, SourceWorkdayArgs args)
public SourceWorkday(String name, SourceWorkdayArgs args, CustomResourceOptions options)

    type: airbyte:SourceWorkday
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SourceWorkdayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SourceWorkdayArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SourceWorkdayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SourceWorkdayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SourceWorkdayArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sourceWorkdayResource = new Airbyte.SourceWorkday("sourceWorkdayResource", new()
{
    Configuration = new Airbyte.Inputs.SourceWorkdayConfigurationArgs
    {
        Credentials = new Airbyte.Inputs.SourceWorkdayConfigurationCredentialsArgs
        {
            ReportBasedStreams = new Airbyte.Inputs.SourceWorkdayConfigurationCredentialsReportBasedStreamsArgs
            {
                Password = "string",
                ReportIds = new[]
                {
                    "string",
                },
                Username = "string",
            },
            RestapiStreams = new Airbyte.Inputs.SourceWorkdayConfigurationCredentialsRestapiStreamsArgs
            {
                AccessToken = "string",
                StartDate = "string",
            },
        },
        Host = "string",
        TenantId = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});

    example, err := airbyte.NewSourceWorkday(ctx, "sourceWorkdayResource", &airbyte.SourceWorkdayArgs{
Configuration: &.SourceWorkdayConfigurationArgs{
Credentials: &.SourceWorkdayConfigurationCredentialsArgs{
ReportBasedStreams: &.SourceWorkdayConfigurationCredentialsReportBasedStreamsArgs{
Password: pulumi.String("string"),
ReportIds: pulumi.StringArray{
pulumi.String("string"),
},
Username: pulumi.String("string"),
},
RestapiStreams: &.SourceWorkdayConfigurationCredentialsRestapiStreamsArgs{
AccessToken: pulumi.String("string"),
StartDate: pulumi.String("string"),
},
},
Host: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})

    var sourceWorkdayResource = new SourceWorkday("sourceWorkdayResource", SourceWorkdayArgs.builder()
    .configuration(SourceWorkdayConfigurationArgs.builder()
        .credentials(SourceWorkdayConfigurationCredentialsArgs.builder()
            .reportBasedStreams(SourceWorkdayConfigurationCredentialsReportBasedStreamsArgs.builder()
                .password("string")
                .reportIds("string")
                .username("string")
                .build())
            .restapiStreams(SourceWorkdayConfigurationCredentialsRestapiStreamsArgs.builder()
                .accessToken("string")
                .startDate("string")
                .build())
            .build())
        .host("string")
        .tenantId("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());

    source_workday_resource = airbyte.SourceWorkday("sourceWorkdayResource",
    configuration={
        "credentials": {
            "report_based_streams": {
                "password": "string",
                "report_ids": ["string"],
                "username": "string",
            },
            "restapi_streams": {
                "access_token": "string",
                "start_date": "string",
            },
        },
        "host": "string",
        "tenant_id": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")

    const sourceWorkdayResource = new airbyte.SourceWorkday("sourceWorkdayResource", {
    configuration: {
        credentials: {
            reportBasedStreams: {
                password: "string",
                reportIds: ["string"],
                username: "string",
            },
            restapiStreams: {
                accessToken: "string",
                startDate: "string",
            },
        },
        host: "string",
        tenantId: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});

    type: airbyte:SourceWorkday
properties:
    configuration:
        credentials:
            reportBasedStreams:
                password: string
                reportIds:
                    - string
                username: string
            restapiStreams:
                accessToken: string
                startDate: string
        host: string
        tenantId: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string

    SourceWorkday Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SourceWorkday resource accepts the following input properties:

    Configuration SourceWorkdayConfiguration
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    Configuration SourceWorkdayConfigurationArgs
    WorkspaceId string
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceWorkdayConfiguration
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceWorkdayConfiguration
    workspaceId string
    definitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name string
    Name of the source e.g. dev-mysql-instance.
    secretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration SourceWorkdayConfigurationArgs
    workspace_id str
    definition_id str
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name str
    Name of the source e.g. dev-mysql-instance.
    secret_id str
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    configuration Property Map
    workspaceId String
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SourceWorkday resource produces the following output properties:

    CreatedAt double
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceId string
    SourceType string
    CreatedAt float64
    Id string
    The provider-assigned unique ID for this managed resource.
    SourceId string
    SourceType string
    createdAt Double
    id String
    The provider-assigned unique ID for this managed resource.
    sourceId String
    sourceType String
    createdAt number
    id string
    The provider-assigned unique ID for this managed resource.
    sourceId string
    sourceType string
    created_at float
    id str
    The provider-assigned unique ID for this managed resource.
    source_id str
    source_type str
    createdAt Number
    id String
    The provider-assigned unique ID for this managed resource.
    sourceId String
    sourceType String

    Look up Existing SourceWorkday Resource

    Get an existing SourceWorkday resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SourceWorkdayState, opts?: CustomResourceOptions): SourceWorkday
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceWorkdayConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceWorkday
    func GetSourceWorkday(ctx *Context, name string, id IDInput, state *SourceWorkdayState, opts ...ResourceOption) (*SourceWorkday, error)
    public static SourceWorkday Get(string name, Input<string> id, SourceWorkdayState? state, CustomResourceOptions? opts = null)
    public static SourceWorkday get(String name, Output<String> id, SourceWorkdayState state, CustomResourceOptions options)
    resources:  _:    type: airbyte:SourceWorkday    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Configuration SourceWorkdayConfiguration
    CreatedAt double
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    SourceId string
    SourceType string
    WorkspaceId string
    Configuration SourceWorkdayConfigurationArgs
    CreatedAt float64
    DefinitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    Name string
    Name of the source e.g. dev-mysql-instance.
    SecretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    SourceId string
    SourceType string
    WorkspaceId string
    configuration SourceWorkdayConfiguration
    createdAt Double
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId String
    sourceType String
    workspaceId String
    configuration SourceWorkdayConfiguration
    createdAt number
    definitionId string
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name string
    Name of the source e.g. dev-mysql-instance.
    secretId string
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId string
    sourceType string
    workspaceId string
    configuration SourceWorkdayConfigurationArgs
    created_at float
    definition_id str
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name str
    Name of the source e.g. dev-mysql-instance.
    secret_id str
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    source_id str
    source_type str
    workspace_id str
    configuration Property Map
    createdAt Number
    definitionId String
    The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
    name String
    Name of the source e.g. dev-mysql-instance.
    secretId String
    Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
    sourceId String
    sourceType String
    workspaceId String

    Supporting Types

    SourceWorkdayConfiguration, SourceWorkdayConfigurationArgs

    Credentials SourceWorkdayConfigurationCredentials
    Report Based Streams and REST API Streams use different methods of Authentication. Choose streams type you want to sync and provide needed credentials for them.
    Host string
    TenantId string
    Credentials SourceWorkdayConfigurationCredentials
    Report Based Streams and REST API Streams use different methods of Authentication. Choose streams type you want to sync and provide needed credentials for them.
    Host string
    TenantId string
    credentials SourceWorkdayConfigurationCredentials
    Report Based Streams and REST API Streams use different methods of Authentication. Choose streams type you want to sync and provide needed credentials for them.
    host String
    tenantId String
    credentials SourceWorkdayConfigurationCredentials
    Report Based Streams and REST API Streams use different methods of Authentication. Choose streams type you want to sync and provide needed credentials for them.
    host string
    tenantId string
    credentials SourceWorkdayConfigurationCredentials
    Report Based Streams and REST API Streams use different methods of Authentication. Choose streams type you want to sync and provide needed credentials for them.
    host str
    tenant_id str
    credentials Property Map
    Report Based Streams and REST API Streams use different methods of Authentication. Choose streams type you want to sync and provide needed credentials for them.
    host String
    tenantId String

    SourceWorkdayConfigurationCredentials, SourceWorkdayConfigurationCredentialsArgs

    SourceWorkdayConfigurationCredentialsReportBasedStreams, SourceWorkdayConfigurationCredentialsReportBasedStreamsArgs

    Password string
    ReportIds List<string>
    Report IDs can be found by clicking the three dots on the right side of the report > Web Service > View URLs > in JSON url copy everything between Workday tenant/ and ?format=json.
    Username string
    Password string
    ReportIds []string
    Report IDs can be found by clicking the three dots on the right side of the report > Web Service > View URLs > in JSON url copy everything between Workday tenant/ and ?format=json.
    Username string
    password String
    reportIds List<String>
    Report IDs can be found by clicking the three dots on the right side of the report > Web Service > View URLs > in JSON url copy everything between Workday tenant/ and ?format=json.
    username String
    password string
    reportIds string[]
    Report IDs can be found by clicking the three dots on the right side of the report > Web Service > View URLs > in JSON url copy everything between Workday tenant/ and ?format=json.
    username string
    password str
    report_ids Sequence[str]
    Report IDs can be found by clicking the three dots on the right side of the report > Web Service > View URLs > in JSON url copy everything between Workday tenant/ and ?format=json.
    username str
    password String
    reportIds List<String>
    Report IDs can be found by clicking the three dots on the right side of the report > Web Service > View URLs > in JSON url copy everything between Workday tenant/ and ?format=json.
    username String

    SourceWorkdayConfigurationCredentialsRestapiStreams, SourceWorkdayConfigurationCredentialsRestapiStreamsArgs

    AccessToken string
    Follow the instructions in the "OAuth 2.0 in Postman - API Client for Integrations" article in the Workday community docs to obtain access token.
    StartDate string
    Rows after this date will be synced, default 2 years ago.
    AccessToken string
    Follow the instructions in the "OAuth 2.0 in Postman - API Client for Integrations" article in the Workday community docs to obtain access token.
    StartDate string
    Rows after this date will be synced, default 2 years ago.
    accessToken String
    Follow the instructions in the "OAuth 2.0 in Postman - API Client for Integrations" article in the Workday community docs to obtain access token.
    startDate String
    Rows after this date will be synced, default 2 years ago.
    accessToken string
    Follow the instructions in the "OAuth 2.0 in Postman - API Client for Integrations" article in the Workday community docs to obtain access token.
    startDate string
    Rows after this date will be synced, default 2 years ago.
    access_token str
    Follow the instructions in the "OAuth 2.0 in Postman - API Client for Integrations" article in the Workday community docs to obtain access token.
    start_date str
    Rows after this date will be synced, default 2 years ago.
    accessToken String
    Follow the instructions in the "OAuth 2.0 in Postman - API Client for Integrations" article in the Workday community docs to obtain access token.
    startDate String
    Rows after this date will be synced, default 2 years ago.

    Import

    $ pulumi import airbyte:index/sourceWorkday:SourceWorkday my_airbyte_source_workday ""

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    airbyte airbytehq/terraform-provider-airbyte
    License
    Notes
    This Pulumi package is based on the airbyte Terraform Provider.
    airbyte logo
    airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq
    airbytehq/terraform-provider-airbyte