Class: AWS.SSOAdmin
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.SSOAdmin
- Identifier:
- ssoadmin
- API Version:
- 2020-07-20
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Sending a Request Using SSOAdmin
var ssoadmin = new AWS.SSOAdmin();
ssoadmin.attachManagedPolicyToPermissionSet(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the SSOAdmin object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var ssoadmin = new AWS.SSOAdmin({apiVersion: '2020-07-20'});
You can also set the API version globally in AWS.config.apiVersions
using
the ssoadmin service identifier:
AWS.config.apiVersions = {
ssoadmin: '2020-07-20',
// other service API versions
};
var ssoadmin = new AWS.SSOAdmin();
Constructor Summary collapse
-
new AWS.SSOAdmin(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
attachManagedPolicyToPermissionSet(params = {}, callback) ⇒ AWS.Request
Attaches an IAM managed policy ARN to a permission set.
-
createAccountAssignment(params = {}, callback) ⇒ AWS.Request
Assigns access to a principal for a specified AWS account using a specified permission set.
-
createInstanceAccessControlAttributeConfiguration(params = {}, callback) ⇒ AWS.Request
Enables the attributes-based access control (ABAC) feature for the specified AWS SSO instance.
-
createPermissionSet(params = {}, callback) ⇒ AWS.Request
Creates a permission set within a specified SSO instance.
-
deleteAccountAssignment(params = {}, callback) ⇒ AWS.Request
Deletes a principal's access from a specified AWS account using a specified permission set.
-
deleteInlinePolicyFromPermissionSet(params = {}, callback) ⇒ AWS.Request
Deletes the inline policy from a specified permission set.
-
deleteInstanceAccessControlAttributeConfiguration(params = {}, callback) ⇒ AWS.Request
Disables the attributes-based access control (ABAC) feature for the specified AWS SSO instance and deletes all of the attribute mappings that have been configured.
-
deletePermissionSet(params = {}, callback) ⇒ AWS.Request
Deletes the specified permission set.
-
describeAccountAssignmentCreationStatus(params = {}, callback) ⇒ AWS.Request
Describes the status of the assignment creation request.
-
describeAccountAssignmentDeletionStatus(params = {}, callback) ⇒ AWS.Request
Describes the status of the assignment deletion request.
-
describeInstanceAccessControlAttributeConfiguration(params = {}, callback) ⇒ AWS.Request
Returns the list of AWS SSO identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified AWS SSO instance.
-
describePermissionSet(params = {}, callback) ⇒ AWS.Request
Gets the details of the permission set.
-
describePermissionSetProvisioningStatus(params = {}, callback) ⇒ AWS.Request
Describes the status for the given permission set provisioning request.
-
detachManagedPolicyFromPermissionSet(params = {}, callback) ⇒ AWS.Request
Detaches the attached IAM managed policy ARN from the specified permission set.
-
getInlinePolicyForPermissionSet(params = {}, callback) ⇒ AWS.Request
Obtains the inline policy assigned to the permission set.
-
listAccountAssignmentCreationStatus(params = {}, callback) ⇒ AWS.Request
Lists the status of the AWS account assignment creation requests for a specified SSO instance.
-
listAccountAssignmentDeletionStatus(params = {}, callback) ⇒ AWS.Request
Lists the status of the AWS account assignment deletion requests for a specified SSO instance.
-
listAccountAssignments(params = {}, callback) ⇒ AWS.Request
Lists the assignee of the specified AWS account with the specified permission set.
-
listAccountsForProvisionedPermissionSet(params = {}, callback) ⇒ AWS.Request
Lists all the AWS accounts where the specified permission set is provisioned.
-
listInstances(params = {}, callback) ⇒ AWS.Request
Lists the SSO instances that the caller has access to.
-
listManagedPoliciesInPermissionSet(params = {}, callback) ⇒ AWS.Request
Lists the IAM managed policy that is attached to a specified permission set.
-
listPermissionSetProvisioningStatus(params = {}, callback) ⇒ AWS.Request
Lists the status of the permission set provisioning requests for a specified SSO instance.
-
listPermissionSets(params = {}, callback) ⇒ AWS.Request
Lists the PermissionSets in an SSO instance.
-
listPermissionSetsProvisionedToAccount(params = {}, callback) ⇒ AWS.Request
Lists all the permission sets that are provisioned to a specified AWS account.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags that are attached to a specified resource.
-
provisionPermissionSet(params = {}, callback) ⇒ AWS.Request
The process by which a specified permission set is provisioned to the specified target.
-
putInlinePolicyToPermissionSet(params = {}, callback) ⇒ AWS.Request
Attaches an IAM inline policy to a permission set.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Associates a set of tags with a specified resource.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Disassociates a set of tags from a specified resource.
-
updateInstanceAccessControlAttributeConfiguration(params = {}, callback) ⇒ AWS.Request
Updates the AWS SSO identity store attributes to use with the AWS SSO instance for attributes-based access control (ABAC).
-
updatePermissionSet(params = {}, callback) ⇒ AWS.Request
Updates an existing permission set.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.SSOAdmin(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
attachManagedPolicyToPermissionSet(params = {}, callback) ⇒ AWS.Request
Attaches an IAM managed policy ARN to a permission set.
ProvisionPermissionSet
after this action to apply the corresponding IAM policy updates to all assigned accounts. createAccountAssignment(params = {}, callback) ⇒ AWS.Request
Assigns access to a principal for a specified AWS account using a specified permission set.
CreateAccountAssignment
call, the specified permission set will automatically be provisioned to the account in the form of an IAM policy attached to the SSO-created IAM role. If the permission set is subsequently updated, the corresponding IAM policies attached to roles in your accounts will not be updated automatically. In this case, you will need to call ProvisionPermissionSet
to make these updates. createInstanceAccessControlAttributeConfiguration(params = {}, callback) ⇒ AWS.Request
Enables the attributes-based access control (ABAC) feature for the specified AWS SSO instance. You can also specify new attributes to add to your ABAC configuration during the enabling process. For more information about ABAC, see Attribute-Based Access Control in the AWS SSO User Guide.
createPermissionSet(params = {}, callback) ⇒ AWS.Request
Creates a permission set within a specified SSO instance.
CreateAccountAssignment
. deleteAccountAssignment(params = {}, callback) ⇒ AWS.Request
Deletes a principal's access from a specified AWS account using a specified permission set.
deleteInlinePolicyFromPermissionSet(params = {}, callback) ⇒ AWS.Request
Deletes the inline policy from a specified permission set.
deleteInstanceAccessControlAttributeConfiguration(params = {}, callback) ⇒ AWS.Request
Disables the attributes-based access control (ABAC) feature for the specified AWS SSO instance and deletes all of the attribute mappings that have been configured. Once deleted, any attributes that are received from an identity source and any custom attributes you have previously configured will not be passed. For more information about ABAC, see Attribute-Based Access Control in the AWS SSO User Guide.
describeAccountAssignmentCreationStatus(params = {}, callback) ⇒ AWS.Request
Describes the status of the assignment creation request.
describeAccountAssignmentDeletionStatus(params = {}, callback) ⇒ AWS.Request
Describes the status of the assignment deletion request.
describeInstanceAccessControlAttributeConfiguration(params = {}, callback) ⇒ AWS.Request
Returns the list of AWS SSO identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified AWS SSO instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the AWS SSO User Guide.
describePermissionSetProvisioningStatus(params = {}, callback) ⇒ AWS.Request
Describes the status for the given permission set provisioning request.
detachManagedPolicyFromPermissionSet(params = {}, callback) ⇒ AWS.Request
Detaches the attached IAM managed policy ARN from the specified permission set.
getInlinePolicyForPermissionSet(params = {}, callback) ⇒ AWS.Request
Obtains the inline policy assigned to the permission set.
listAccountAssignmentCreationStatus(params = {}, callback) ⇒ AWS.Request
Lists the status of the AWS account assignment creation requests for a specified SSO instance.
listAccountAssignmentDeletionStatus(params = {}, callback) ⇒ AWS.Request
Lists the status of the AWS account assignment deletion requests for a specified SSO instance.
listAccountAssignments(params = {}, callback) ⇒ AWS.Request
Lists the assignee of the specified AWS account with the specified permission set.
listAccountsForProvisionedPermissionSet(params = {}, callback) ⇒ AWS.Request
Lists all the AWS accounts where the specified permission set is provisioned.
listInstances(params = {}, callback) ⇒ AWS.Request
Lists the SSO instances that the caller has access to.
listManagedPoliciesInPermissionSet(params = {}, callback) ⇒ AWS.Request
Lists the IAM managed policy that is attached to a specified permission set.
listPermissionSetProvisioningStatus(params = {}, callback) ⇒ AWS.Request
Lists the status of the permission set provisioning requests for a specified SSO instance.
listPermissionSets(params = {}, callback) ⇒ AWS.Request
Lists the PermissionSets in an SSO instance.
listPermissionSetsProvisionedToAccount(params = {}, callback) ⇒ AWS.Request
Lists all the permission sets that are provisioned to a specified AWS account.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags that are attached to a specified resource.
provisionPermissionSet(params = {}, callback) ⇒ AWS.Request
The process by which a specified permission set is provisioned to the specified target.
putInlinePolicyToPermissionSet(params = {}, callback) ⇒ AWS.Request
Attaches an IAM inline policy to a permission set.
ProvisionPermissionSet
after this action to apply the corresponding IAM policy updates to all assigned accounts. tagResource(params = {}, callback) ⇒ AWS.Request
Associates a set of tags with a specified resource.
untagResource(params = {}, callback) ⇒ AWS.Request
Disassociates a set of tags from a specified resource.
updateInstanceAccessControlAttributeConfiguration(params = {}, callback) ⇒ AWS.Request
Updates the AWS SSO identity store attributes to use with the AWS SSO instance for attributes-based access control (ABAC). When using an external identity provider as an identity source, you can pass attributes through the SAML assertion as an alternative to configuring attributes from the AWS SSO identity store. If a SAML assertion passes any of these attributes, AWS SSO will replace the attribute value with the value from the AWS SSO identity store. For more information about ABAC, see Attribute-Based Access Control in the AWS SSO User Guide.