DescribeWorkspaceAuthenticationCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GrafanaClient, DescribeWorkspaceAuthenticationCommand } from "@aws-sdk/client-grafana"; // ES Modules import
// const { GrafanaClient, DescribeWorkspaceAuthenticationCommand } = require("@aws-sdk/client-grafana"); // CommonJS import
const client = new GrafanaClient(config);
const input = { // DescribeWorkspaceAuthenticationRequest
  workspaceId: "STRING_VALUE", // required
};
const command = new DescribeWorkspaceAuthenticationCommand(input);
const response = await client.send(command);
// { // DescribeWorkspaceAuthenticationResponse
//   authentication: { // AuthenticationDescription
//     providers: [ // AuthenticationProviders // required
//       "STRING_VALUE",
//     ],
//     saml: { // SamlAuthentication
//       status: "STRING_VALUE", // required
//       configuration: { // SamlConfiguration
//         idpMetadata: { // IdpMetadata Union: only one key present
//           url: "STRING_VALUE",
//           xml: "STRING_VALUE",
//         },
//         assertionAttributes: { // AssertionAttributes
//           name: "STRING_VALUE",
//           login: "STRING_VALUE",
//           email: "STRING_VALUE",
//           groups: "STRING_VALUE",
//           role: "STRING_VALUE",
//           org: "STRING_VALUE",
//         },
//         roleValues: { // RoleValues
//           editor: [ // RoleValueList
//             "STRING_VALUE",
//           ],
//           admin: [
//             "STRING_VALUE",
//           ],
//         },
//         allowedOrganizations: [ // AllowedOrganizations
//           "STRING_VALUE",
//         ],
//         loginValidityDuration: Number("int"),
//       },
//     },
//     awsSso: { // AwsSsoAuthentication
//       ssoClientId: "STRING_VALUE",
//     },
//   },
// };

DescribeWorkspaceAuthenticationCommand Input

See DescribeWorkspaceAuthenticationCommandInput for more details

Parameter
Type
Description
workspaceId
Required
string | undefined

The ID of the workspace to return authentication information about.

DescribeWorkspaceAuthenticationCommand Output

See DescribeWorkspaceAuthenticationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
authentication
Required
AuthenticationDescription | undefined

A structure containing information about the authentication methods used in the workspace.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient permissions to perform this action.

ConflictException
client

A resource was in an inconsistent state during an update or a deletion.

InternalServerException
server

Unexpected error while processing the request. Retry the request.

ResourceNotFoundException
client

The request references a resource that does not exist.

ThrottlingException
client

The request was denied because of request throttling. Retry the request.

ValidationException
client

The value of a parameter in the request caused an error.

GrafanaServiceException
Base exception class for all service exceptions from Grafana service.