Skip to content

Describe Identity Provider Configuration

workmail_describe_identity_provider_configuration R Documentation

Returns detailed information on the current IdC setup for the WorkMail organization

Description

Returns detailed information on the current IdC setup for the WorkMail organization.

Usage

workmail_describe_identity_provider_configuration(OrganizationId)

Arguments

OrganizationId

[required] The Organization ID.

Value

A list with the following syntax:

list(
  AuthenticationMode = "IDENTITY_PROVIDER_ONLY"|"IDENTITY_PROVIDER_AND_DIRECTORY",
  IdentityCenterConfiguration = list(
    InstanceArn = "string",
    ApplicationArn = "string"
  ),
  PersonalAccessTokenConfiguration = list(
    Status = "ACTIVE"|"INACTIVE",
    LifetimeInDays = 123
  )
)

Request syntax

svc$describe_identity_provider_configuration(
  OrganizationId = "string"
)