Method: legacySoarIdpMappingGroups.getExternalProviders

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

Gets the external providers for a LegacySoarIdpMappingGroup.

HTTP request


Path parameters

Parameters
name

string

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

Query parameters

Parameters
providerName

string
providerType

enum (LegacySoarIdpMappingGroupIdentityProviderType)

Request body

The request body must be empty.

Response body

Response message for legacySoarIdpMappingGroups.getExternalProviders.

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

JSON representation 
{
  "payload": [
    {
      object (LegacySoarIdpMappingGroupExternalProvider)
    }
  ]
}
Fields
payload[]

object (LegacySoarIdpMappingGroupExternalProvider)

Required. The list of external providers for the LegacySoarIdpMappingGroup.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

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.

LegacySoarIdpMappingGroupExternalProvider

External providers for a LegacySoarIdpMappingGroup.

JSON representation 
{
  "providerName": string,
  "identityProviderType": enum (LegacySoarIdpMappingGroupIdentityProviderType),
  "remoteEntityIdUrl": string,
  "localEntityIdUrl": string,
  "id": string,
  "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
  ],
  "publicCertificate": {
    object (UploadSamlSettings)
  },
  "metadata": {
    object (UploadSamlSettings)
  },
  "autoRedirect": boolean,
  "autoAddUser": boolean,
  "allowUnsolicitedResponse": boolean,
  "areSamlSettingsInUse": boolean,
  "isIdentityProviderManaged": boolean
}
Fields
providerName

string

Identifier. The name of the provider.
identityProviderType

enum (LegacySoarIdpMappingGroupIdentityProviderType)

Required. The type of the identity provider.
remoteEntityIdUrl

string

Optional. The URL for the remote entity ID.
localEntityIdUrl

string

Optional. The URL for the local entity ID.
id

string

Output only. The unique ID of the external provider.
firstNameAttribute

string

Optional. The attribute for the first name.
lastNameAttribute

string

Optional. The attribute for the last name.
usernameAttribute

string

Optional. The attribute for the username.
emailAttribute

string

Optional. The attribute for the email.
groupsNameAttribute

string

Optional. The attribute for the groups name.
defaultLicenseType

enum (PermissionTypeEnum)

Optional. The default license type.
defaultSocRoleId
(deprecated)

string (int64 format)

Optional. Obsolete: The default SOC role ID. Use defaultSocRoleIds instead.
defaultSocRoleIds[]

string (int64 format)

Optional. The default SOC role IDs.
defaultPermissionGroup
(deprecated)

string

Optional. Obsolete: The default permission group. Use defaultPermissionGroups instead.
defaultPermissionGroups[]

string

Optional. The default permission groups.
defaultEnvironments[]

string

Optional. The default environments.
defaultPlatforms[]

string (int64 format)

Optional. The default platforms.
publicCertificate

object (UploadSamlSettings)

Optional. The public certificate for the identity provider.
metadata

object (UploadSamlSettings)

Optional. The metadata for the identity provider.
autoRedirect

boolean

Optional. Indicates if auto redirect is enabled.
autoAddUser

boolean

Optional. Indicates if auto add user is enabled.
allowUnsolicitedResponse

boolean

Optional. Indicates if unsolicited response is allowed.
areSamlSettingsInUse

boolean

Optional. Indicates if SAML settings are in use.
isIdentityProviderManaged

boolean

Optional. Indicates if the identity provider is managed.

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.