Skip to content
Ona API Reference
Ona Docs
API Reference
Organizations
Scim Configurations

UpdateSCIMConfiguration

client.Organizations.ScimConfigurations.Update(ctx, body) (*OrganizationScimConfigurationUpdateResponse, error)
POST/gitpod.v1.OrganizationService/UpdateSCIMConfiguration

Updates a SCIM configuration.

Use this method to:

  • Enable or disable SCIM provisioning
  • Link or unlink SSO configuration
  • Update configuration name

Examples

  • Disable SCIM:

    Disables SCIM provisioning.

    scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
enabled: false

  • Link to SSO:

    Links SCIM configuration to an SSO provider.

    scimConfigurationId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
ssoConfigurationId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
ParametersExpand Collapse
body OrganizationScimConfigurationUpdateParams
ScimConfigurationID param.Field[string]

scim_configuration_id is the ID of the SCIM configuration to update

formatuuid
AllowUnverifiedEmailAccountLinking param.Field[bool]Optional

allow_unverified_email_account_linking allows SCIM to link provisioned users to existing accounts when the identity provider does not mark the email address as verified

Enabled param.Field[bool]Optional

enabled controls whether SCIM provisioning is active

Name param.Field[string]Optional

name is a human-readable name for the SCIM configuration

maxLength128
SSOConfigurationID param.Field[string]Optional

sso_configuration_id is the SSO configuration to link

formatuuid
ReturnsExpand Collapse
type OrganizationScimConfigurationUpdateResponse struct{…}
ScimConfiguration ScimConfiguration

scim_configuration is the updated SCIM configuration

ID string

id is the unique identifier of the SCIM configuration

formatuuid
CreatedAt Time

created_at is when the SCIM configuration was created

formatdate-time
OrganizationID string

organization_id is the ID of the organization this SCIM configuration belongs to

formatuuid
TokenExpiresAt Time

token_expires_at is when the current SCIM token expires

formatdate-time
UpdatedAt Time

updated_at is when the SCIM configuration was last updated

formatdate-time
AllowUnverifiedEmailAccountLinking boolOptional

allow_unverified_email_account_linking allows SCIM to link provisioned users to existing accounts when the identity provider does not mark the email address as verified

Enabled boolOptional

enabled indicates if SCIM provisioning is active

Name stringOptional

name is a human-readable name for the SCIM configuration

maxLength128
SSOConfigurationID stringOptional

sso_configuration_id is the linked SSO configuration (optional)

formatuuid

UpdateSCIMConfiguration

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  scimConfiguration, err := client.Organizations.ScimConfigurations.Update(context.TODO(), gitpod.OrganizationScimConfigurationUpdateParams{
    ScimConfigurationID: gitpod.F("d2c94c27-3b76-4a42-b88c-95a85e392c68"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", scimConfiguration.ScimConfiguration)
}

{
  "scimConfiguration": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "tokenExpiresAt": "2019-12-27T18:11:19.117Z",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "allowUnverifiedEmailAccountLinking": true,
    "enabled": true,
    "name": "name",
    "ssoConfigurationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}
Returns Examples
{
  "scimConfiguration": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "createdAt": "2019-12-27T18:11:19.117Z",
    "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "tokenExpiresAt": "2019-12-27T18:11:19.117Z",
    "updatedAt": "2019-12-27T18:11:19.117Z",
    "allowUnverifiedEmailAccountLinking": true,
    "enabled": true,
    "name": "name",
    "ssoConfigurationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}