Disassociate Principal From Portfolio

servicecatalog_disassociate_principal_from_portfolio

R Documentation

Disassociates a previously associated principal ARN from a specified portfolio¶

Description¶

Disassociates a previously associated principal ARN from a specified portfolio.

The PrincipalType and PrincipalARN must match the associate_principal_with_portfolio call request details. For example, to disassociate an association created with a PrincipalARN of PrincipalType IAM you must use the PrincipalType IAM when calling disassociate_principal_from_portfolio.

For portfolios that have been shared with principal name sharing enabled: after disassociating a principal, share recipient accounts will no longer be able to provision products in this portfolio using a role matching the name of the associated principal.

For more information, review associate-principal-with-portfolio in the Amazon Web Services CLI Command Reference.

If you disassociate a principal from a portfolio, with PrincipalType as IAM, the same principal will still have access to the portfolio if it matches one of the associated principals of type IAM_PATTERN. To fully remove access for a principal, verify all the associated Principals of type IAM_PATTERN, and then ensure you disassociate any IAM_PATTERN principals that match the principal whose access you are removing.

Usage¶

servicecatalog_disassociate_principal_from_portfolio(AcceptLanguage,
  PortfolioId, PrincipalARN, PrincipalType)

Arguments¶

AcceptLanguage

The language code.

jp - Japanese
zh - Chinese

PortfolioId

[required] The portfolio identifier.

PrincipalARN

[required] The ARN of the principal (user, role, or group). This field allows an ARN with no accountID with or without wildcard characters if PrincipalType is IAM_PATTERN.

PrincipalType

The supported value is IAM if you use a fully defined ARN, or IAM_PATTERN if you specify an IAM ARN with no AccountId, with or without wildcard characters.

Value¶

An empty list.

Request syntax¶

svc$disassociate_principal_from_portfolio(
  AcceptLanguage = "string",
  PortfolioId = "string",
  PrincipalARN = "string",
  PrincipalType = "IAM"|"IAM_PATTERN"
)