Method: legacySoarIdpMappingGroups.updateDefaultAccessSettings

Full name: projects.locations.instances.legacySoarIdpMappingGroups.updateDefaultAccessSettings

Patches the external providers for a LegacySoarIdpMappingGroup.

HTTP request


Path parameters

Parameters
name

string

Required. Format: projects/{project}/locations/{location}/instances/{instance}/legacySoarIdpMappingGroups/{legacySoarIdpMappingGroup}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "id": string,
  "patchExternalProviderRequest": {
    object (PatchExternalProviderRequest)
  },
  "updateMask": string
}
Fields
id

string

Optional. The unique ID of the LegacySoarIdpMappingGroup.
patchExternalProviderRequest

object (PatchExternalProviderRequest)
updateMask

string (FieldMask format)

Optional. The list of fields to update. If not included, all fields with default/non-default values will be overwritten.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Response body

Response message to patch the external providers for a LegacySoarIdpMappingGroup.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "providerName": string,
  "identityProviderType": enum (LegacySoarIdpMappingGroupIdentityProviderType),
  "remoteEntityIdUrl": string,
  "localEntityIdUrl": string,
  "metadata": {
    object (UploadSamlSettings)
  },
  "publicCertificate": {
    object (UploadSamlSettings)
  },
  "firstNameAttribute": string,
  "lastNameAttribute": string,
  "usernameAttribute": string,
  "emailAttribute": string,
  "groupsNameAttribute": string,
  "defaultLicenseType": enum (PermissionTypeEnum),
  "defaultSocRoleId": string,
  "defaultSocRoleIds": [
    string
  ],
  "defaultPermissionGroup": string,
  "defaultPermissionGroups": [
    string
  ],
  "defaultEnvironments": [
    string
  ],
  "defaultPlatforms": [
    string
  ],
  "id": string,
  "autoRedirect": boolean,
  "autoAddUser": boolean,
  "areSamlSettingsInUse": boolean,
  "isIdentityProviderManaged": boolean,
  "allowUnsolicitedResponse": boolean
}
Fields
providerName

string

Optional. Name of the provider, this field is unique. Example: oktaProvider
identityProviderType

enum (LegacySoarIdpMappingGroupIdentityProviderType)

Optional. The provider type, it is an enum value. Example: 1: Google Workspace.
remoteEntityIdUrl

string

Optional. The identifier of the IDP. Example: http://www.okta.com/exk95djonm0rDdj
localEntityIdUrl

string

Optional. The ACS URL. Example: https://mydomain.net/Saml2
metadata

object (UploadSamlSettings)

Optional. IDP metadata file. This field was removed because the type UploadSamlSettings is not defined.
publicCertificate

object (UploadSamlSettings)

Output only. IDP public certificate. This field was removed because the type UploadSamlSettings is not defined.
firstNameAttribute

string

Optional. Name of the field from which first name is extracted. Example: FirstName
lastNameAttribute

string

Optional. Name of the field from which last name is extracted. Example: LastName
usernameAttribute

string

Optional. Name of the field from which login id is extracted. Example: Username
emailAttribute

string

Optional. Name of the field from which user email is extracted. Example: Primary email
groupsNameAttribute

string

Optional. Name of the field from which user groups is extracted. Example: Admins
defaultLicenseType

enum (PermissionTypeEnum)

Optional. Enum of the type of license the new user will have. (only applicable on just in time user provisioning). Example: 1: view only.
defaultSocRoleId

string (int64 format)

Optional. The role of the new user.(only applicable on just in time user provisioning). Example: 1: Administrator
defaultSocRoleIds[]

string (int64 format)

Optional. The roles of the new user.(only applicable on just in time user provisioning). Example: 1: Administrator, 2: @Tier1
defaultPermissionGroup

string

Optional. The permission group of the new user. (only applicable on just in time user provisioning). Example: Admins
defaultPermissionGroups[]

string

Optional. The permission groups of the new user. (only applicable on just in time user provisioning). Example: Admins, Readers
defaultEnvironments[]

string

Optional. The environments the new user will be exposed to. (only applicable on just in time user provisioning). Example: MyEnvironment
defaultPlatforms[]

string (int64 format)

Optional. The platforms the new user will be exposed to. (only applicable on just in time user provisioning). Example: [1, 2]
id

string

Output only. The unique ID of the LegacySoarIdpMappingGroup.
autoRedirect

boolean

Optional. Decides if user can be automatically authenticated. When there is more than one provider this should be always false.
autoAddUser

boolean

Optional. Created user dynamically when the log in based on the attributes configured. When there is more than one provider this should be always false.
areSamlSettingsInUse

boolean

Optional. Are the settings enabled.
isIdentityProviderManaged

boolean

Optional. Is the user managed by the IDP.
allowUnsolicitedResponse

boolean

Optional. User will automatically be logged in into the system from external provider application.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

PatchExternalProviderRequest

Represents an external identity provider mapper settings.

JSON representation 
{
  "providerName": string,
  "identityProviderType": enum (LegacySoarIdpMappingGroupIdentityProviderType),
  "remoteEntityIdUrl": string,
  "localEntityIdUrl": string,
  "metadata": {
    object (UploadSamlSettings)
  },
  "publicCertificate": {
    object (UploadSamlSettings)
  },
  "firstNameAttribute": string,
  "lastNameAttribute": string,
  "usernameAttribute": string,
  "emailAttribute": string,
  "groupsNameAttribute": string,
  "defaultLicenseType": enum (PermissionTypeEnum),
  "defaultSocRoleId": string,
  "defaultSocRoleIds": [
    string
  ],
  "defaultPermissionGroup": string,
  "defaultPermissionGroups": [
    string
  ],
  "defaultEnvironments": [
    string
  ],
  "defaultPlatforms": [
    string
  ],
  "autoRedirect": boolean,
  "autoAddUser": boolean,
  "areSamlSettingsInUse": boolean,
  "isIdentityProviderManaged": boolean,
  "allowUnsolicitedResponse": boolean
}
Fields
providerName

string

Optional. Name of the provider, this field is unique. Example: oktaProvider
identityProviderType

enum (LegacySoarIdpMappingGroupIdentityProviderType)

Optional. The provider type, it is an enum value. Example: 1: Google Workspace.
remoteEntityIdUrl

string

Optional. The identifier of the IDP. Example: http://www.okta.com/exk95djonm0rDdj
localEntityIdUrl

string

Optional. The ACS URL. Example: https://mydomain.net/Saml2
metadata

object (UploadSamlSettings)

Optional. IDP metadata file. This field was removed because the type UploadSamlSettings is not defined.
publicCertificate

object (UploadSamlSettings)

Output only. IDP public certificate. This field was removed because the type UploadSamlSettings is not defined.
firstNameAttribute

string

Optional. Name of the field from which first name is extracted. Example: FirstName
lastNameAttribute

string

Optional. Name of the field from which last name is extracted. Example: LastName
usernameAttribute

string

Optional. Name of the field from which login id is extracted. Example: Username
emailAttribute

string

Optional. Name of the field from which user email is extracted. Example: Primary email
groupsNameAttribute

string

Optional. Name of the field from which user groups is extracted. Example: Admins
defaultLicenseType

enum (PermissionTypeEnum)

Optional. Enum of the type of license the new user will have. (only applicable on just in time user provisioning). Example: 1: view only.
defaultSocRoleId

string (int64 format)

Optional. The role of the new user.(only applicable on just in time user provisioning). Example: 1: Administrator
defaultSocRoleIds[]

string (int64 format)

Optional. The roles of the new user.(only applicable on just in time user provisioning). Example: 1: Administrator, 2: @Tier1
defaultPermissionGroup

string

Optional. The permission group of the new user. (only applicable on just in time user provisioning). Example: Admins
defaultPermissionGroups[]

string

Optional. The permission groups of the new user. (only applicable on just in time user provisioning). Example: Admins, Readers
defaultEnvironments[]

string

Optional. The environments the new user will be exposed to. (only applicable on just in time user provisioning). Example: MyEnvironment
defaultPlatforms[]

string (int64 format)

Optional. The platforms the new user will be exposed to. (only applicable on just in time user provisioning). Example: [1, 2]
autoRedirect

boolean

Optional. Decides if user can be automatically authenticated. When there is more than one provider this should be always false.
autoAddUser

boolean

Optional. Created user dynamically when the log in based on the attributes configured. When there is more than one provider this should be always false.
areSamlSettingsInUse

boolean

Optional. Are the settings enabled.
isIdentityProviderManaged

boolean

Optional. Is the user managed by the IDP.
allowUnsolicitedResponse

boolean

Optional. User will automatically be logged in into the system from external provider application.

LegacySoarIdpMappingGroupIdentityProviderType

The type of the identity provider.

Enums
OKTA Okta identity provider type.
NONE None identity provider type.
GSUITE Google Workspace identity provider type.
CUSTOM_SAML2 Custom SAML2 identity provider type.

PermissionTypeEnum

The type of the permission.

Enums
REGULAR Regular permission type.
VIEW_ONLY View only permission type.
COLLABORATOR Collaborator permission type.
MANAGED_USER Managed user permission type.
MANAGED_USER_PLUS Managed user plus permission type.

LegacySoarIdpMappingGroupIdentityProviderType

The type of the identity provider.

Enums
OKTA Okta identity provider type.
NONE None identity provider type.
GSUITE Google Workspace identity provider type.
CUSTOM_SAML2 Custom SAML2 identity provider type.

PermissionTypeEnum

The type of the permission.

Enums
REGULAR Regular permission type.
VIEW_ONLY View only permission type.
COLLABORATOR Collaborator permission type.
MANAGED_USER Managed user permission type.
MANAGED_USER_PLUS Managed user plus permission type.