Update Provider

UpdateProvider updates a provider’s mutable fields (display_name, description, disabled). The issuer_url is immutable after creation.

PATCH /api/v1/workload_federation/providers/{id}

UpdateProvider

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.WorkloadFederation.UpdateProvider(ctx, operations.C1APIWorkloadFederationV1WorkloadFederationServiceUpdateProviderRequest{
        ID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.WorkloadFederationServiceUpdateProviderResponse != nil {
        // handle response
    }
}

200

{
  "provider": {
    "createdAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "disabled": true,
    "displayName": "<string>",
    "id": "<string>",
    "issuerUrl": "<string>",
    "oidc": {},
    "spiffe": {
      "bundleEndpointUrl": "<string>"
    },
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

id · string · required · read-only

The unique ID of the provider.

Body

application/json

The WorkloadFederationServiceUpdateProviderRequest message.

provider · Workload Federation Provider · object

WorkloadFederationProvider represents a tenant-level workload identity issuer registration. Two issuer schemes are supported:

• https://... classic OIDC issuer; settings.oidc MUST be set.
• spiffe://... SPIFFE trust-domain URI; settings.spiffe MUST be set.

The (well_known_provider, issuer_url scheme, settings oneof) tuple is a tri-invariant: SPIFFE wkp ⟺ spiffe:// issuer ⟺ settings.spiffe set; any other wkp ⟺ https:// issuer ⟺ settings.oidc set. Issuer URLs are unique within tenant.

This message contains a oneof named settings. Only a single field of the following list may be set at a time:

• oidc
• spiffe

Show child attributes

updateMask · string | null

Response

200 - application/json

Successful response

The WorkloadFederationServiceUpdateProviderResponse message.

provider · Workload Federation Provider · object

WorkloadFederationProvider represents a tenant-level workload identity issuer registration. Two issuer schemes are supported:

• https://... classic OIDC issuer; settings.oidc MUST be set.
• spiffe://... SPIFFE trust-domain URI; settings.spiffe MUST be set.

The (well_known_provider, issuer_url scheme, settings oneof) tuple is a tri-invariant: SPIFFE wkp ⟺ spiffe:// issuer ⟺ settings.spiffe set; any other wkp ⟺ https:// issuer ⟺ settings.oidc set. Issuer URLs are unique within tenant.

This message contains a oneof named settings. Only a single field of the following list may be set at a time:

• oidc
• spiffe

Show child attributes