Skip to content

Describe Workspace Authentication

managedgrafana_describe_workspace_authentication R Documentation

Displays information about the authentication methods used in one Amazon Managed Grafana workspace

Description

Displays information about the authentication methods used in one Amazon Managed Grafana workspace.

Usage

managedgrafana_describe_workspace_authentication(workspaceId)

Arguments

workspaceId

[required] The ID of the workspace to return authentication information about.

Value

A list with the following syntax:

list(
  authentication = list(
    providers = list(
      "AWS_SSO"|"SAML"
    ),
    saml = list(
      status = "CONFIGURED"|"NOT_CONFIGURED",
      configuration = list(
        idpMetadata = list(
          url = "string",
          xml = "string"
        ),
        assertionAttributes = list(
          name = "string",
          login = "string",
          email = "string",
          groups = "string",
          role = "string",
          org = "string"
        ),
        roleValues = list(
          editor = list(
            "string"
          ),
          admin = list(
            "string"
          )
        ),
        allowedOrganizations = list(
          "string"
        ),
        loginValidityDuration = 123
      )
    ),
    awsSso = list(
      ssoClientId = "string"
    )
  )
)

Request syntax

svc$describe_workspace_authentication(
  workspaceId = "string"
)