Create Pending

Create Delegated

client.Apps.Connectors.NewPending(ctx, appID, body) (*ConnectorViewC1APIAppV1ConnectorViewExpandedarrayC1APIAppV1ConnectorServiceCreateResponse, error)

post/api/v1/apps/{app_id}/connectors

Create a connector that is pending a connector config.

Parameters

appIDstring

The appId of the app the connector is attached to.

bodyAppManagedStateBindingReffieldCatalogIDfieldDescriptionfieldDisplayNamefieldExpandMaskfieldUserIDsfieldAppConnectorNewPendingParams

Hide ParametersShow Parameters

AppManagedStateBindingReffield

optional

param.Field[AppConnectorNewPendingParamsAppManagedStateBindingRef]

The AppManagedStateBindingRef message.

Hide ParametersShow Parameters

AppIDstring

optional

The appId field.

ResourceIDstring

optional

The resourceId field.

ResourceTypeIDstring

optional

The resourceTypeId field.

CatalogIDfield

optional

param.Field[string]

The catalogId describes which catalog entry this connector is an instance of. For example, every Okta connector will have the same catalogId indicating it is an Okta connector.

Descriptionfield

optional

param.Field[string]

The description of the connector.

DisplayNamefield

optional

param.Field[string]

The displayName of the connector.

ExpandMaskfield

optional

param.Field[PathsarrayC1APIAppV1ConnectorExpandMask]

The ConnectorExpandMask is used to expand related objects on a connector.

UserIDsfield

optional

param.Field[[]string]

The userIds field is used to define the integration owners of the connector.

Returns

ConnectorViewC1APIAppV1ConnectorViewExpandedarrayC1APIAppV1ConnectorServiceCreateResponse

Request example Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  c1APIAppV1ConnectorServiceCreateResponse, err := client.Apps.Connectors.NewPending(
    context.TODO(),
    "app_id",
    conductoronesdk.AppConnectorNewPendingParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", c1APIAppV1ConnectorServiceCreateResponse.ConnectorView)
}

200 Example

{
  "connectorView": {
    "appPath": "appPath",
    "connector": {
      "id": "id",
      "appId": "appId",
      "catalogId": "catalogId",
      "config": {
        "@type": "@type"
      },
      "description": "description",
      "displayName": "displayName",
      "oauthAuthorizedAs": {},
      "profileAllowList": [
        "string"
      ],
      "profileIgnoreList": [
        "string"
      ],
      "status": {
        "completedAt": "2019-12-27T18:11:19.117Z",
        "lastError": "lastError",
        "startedAt": "2019-12-27T18:11:19.117Z",
        "status": "SYNC_STATUS_UNSPECIFIED",
        "updatedAt": "2019-12-27T18:11:19.117Z"
      },
      "syncDisabledCategory": "syncDisabledCategory",
      "syncDisabledReason": "syncDisabledReason",
      "userIds": [
        "string"
      ]
    },
    "usersPath": "usersPath"
  },
  "expanded": [
    {
      "@type": "@type"
    }
  ]
}