Skip to content

Get User Profile

datazone_get_user_profile R Documentation

Gets a user profile in Amazon DataZone

Description

Gets a user profile in Amazon DataZone.

Usage

datazone_get_user_profile(domainIdentifier, userIdentifier, type,
  sessionName)

Arguments

domainIdentifier

[required] the ID of the Amazon DataZone domain the data portal of which you want to get.

userIdentifier

[required] The identifier of the user for which you want to get the user profile.

type

The type of the user profile.

sessionName

The session name for IAM role sessions.

Value

A list with the following syntax:

list(
  domainId = "string",
  id = "string",
  type = "IAM"|"SSO",
  status = "ASSIGNED"|"NOT_ASSIGNED"|"ACTIVATED"|"DEACTIVATED",
  details = list(
    iam = list(
      arn = "string",
      principalId = "string",
      sessionName = "string",
      groupProfileId = "string"
    ),
    sso = list(
      username = "string",
      firstName = "string",
      lastName = "string"
    )
  )
)

Request syntax

svc$get_user_profile(
  domainIdentifier = "string",
  userIdentifier = "string",
  type = "IAM"|"SSO",
  sessionName = "string"
)