Class: AWS.SSOAdmin

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  ManagedPolicyArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.attachManagedPolicyToPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • ManagedPolicyArn — (String)

    The Amazon Web Services managed policy ARN to be attached to a permission set.

  • PermissionSetArn — (String)

    The ARN of the PermissionSet that the managed policy should be attached to.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  PrincipalId: 'STRING_VALUE', /* required */
  PrincipalType: USER | GROUP, /* required */
  TargetId: 'STRING_VALUE', /* required */
  TargetType: AWS_ACCOUNT /* required */
};
ssoadmin.createAccountAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • PermissionSetArn — (String)

    The ARN of the permission set that the admin wants to grant the principal access to.

  • PrincipalId — (String)

    An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

  • PrincipalType — (String)

    The entity type for which the assignment will be created.

    Possible values include:
    • "USER"
    • "GROUP"
  • TargetId — (String)

    TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

  • TargetType — (String)

    The entity type for which the assignment will be created.

    Possible values include:
    • "AWS_ACCOUNT"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountAssignmentCreationStatus — (map)

      The status object for the account assignment creation operation.

      • CreatedDate — (Date)

        The date that the permission set was created.

      • FailureReason — (String)

        The message that contains an error or exception in case of an operation failure.

      • PermissionSetArn — (String)

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

      • PrincipalId — (String)

        An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

      • PrincipalType — (String)

        The entity type for which the assignment will be created.

        Possible values include:
        • "USER"
        • "GROUP"
      • RequestId — (String)

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • Status — (String)

        The status of the permission set provisioning process.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "SUCCEEDED"
      • TargetId — (String)

        TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

      • TargetType — (String)

        The entity type for which the assignment will be created.

        Possible values include:
        • "AWS_ACCOUNT"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationProviderArn: 'STRING_VALUE', /* required */
  InstanceArn: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  PortalOptions: {
    SignInOptions: {
      Origin: IDENTITY_CENTER | APPLICATION, /* required */
      ApplicationUrl: 'STRING_VALUE'
    },
    Visibility: ENABLED | DISABLED
  },
  Status: ENABLED | DISABLED,
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ssoadmin.createApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationProviderArn — (String)

    The ARN of the application provider under which the operation will run.

  • ClientToken — (String)

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    If a token is not provided, the SDK will use a version 4 UUID.
  • Description — (String)

    The description of the .

  • InstanceArn — (String)

    The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • Name — (String)

    The name of the .

  • PortalOptions — (map)

    A structure that describes the options for the portal associated with an application.

    • SignInOptions — (map)

      A structure that describes the sign-in options for the access portal.

      • ApplicationUrl — (String)

        The URL that accepts authentication requests for an application. This is a required parameter if the Origin parameter is APPLICATION.

      • Origin — required — (String)

        This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values:

        • APPLICATION: IAM Identity Center redirects the customer to the configured ApplicationUrl.

        • IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.

        Possible values include:
        • "IDENTITY_CENTER"
        • "APPLICATION"
    • Visibility — (String)

      Indicates whether this application is visible in the access portal.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
  • Status — (String)

    Specifies whether the application is enabled or disabled.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • Tags — (Array<map>)

    Specifies tags to be attached to the application.

    • Key — required — (String)

      The key for the tag.

    • Value — required — (String)

      The value of the tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ApplicationArn — (String)

      Specifies the ARN of the application.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  PrincipalId: 'STRING_VALUE', /* required */
  PrincipalType: USER | GROUP /* required */
};
ssoadmin.createApplicationAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    The ARN of the application provider under which the operation will run.

  • PrincipalId — (String)

    An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

  • PrincipalType — (String)

    The entity type for which the assignment will be created.

    Possible values include:
    • "USER"
    • "GROUP"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ClientToken: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ssoadmin.createInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    If a token is not provided, the SDK will use a version 4 UUID.
  • Name — (String)

    The name of the instance of IAM Identity Center.

  • Tags — (Array<map>)

    Specifies tags to be attached to the instance of IAM Identity Center.

    • Key — required — (String)

      The key for the tag.

    • Value — required — (String)

      The value of the tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InstanceArn — (String)

      The ARN of the instance of IAM Identity Center under which the operation will run.

      For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceAccessControlAttributeConfiguration: { /* required */
    AccessControlAttributes: [ /* required */
      {
        Key: 'STRING_VALUE', /* required */
        Value: { /* required */
          Source: [ /* required */
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      /* more items */
    ]
  },
  InstanceArn: 'STRING_VALUE' /* required */
};
ssoadmin.createInstanceAccessControlAttributeConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceAccessControlAttributeConfiguration — (map)

    Specifies the IAM Identity Center identity store attributes to add to your ABAC configuration. When using an external identity provider as an identity source, you can pass attributes through the SAML assertion. Doing so provides an alternative to configuring attributes from the IAM Identity Center identity store. If a SAML assertion passes any of these attributes, IAM Identity Center will replace the attribute value with the value from the IAM Identity Center identity store.

    • AccessControlAttributes — required — (Array<map>)

      Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance.

      • Key — required — (String)

        The name of the attribute associated with your identities in your identity source. This is used to map a specified attribute in your identity source with an attribute in IAM Identity Center.

      • Value — required — (map)

        The value used for mapping a specified attribute to an identity source.

        • Source — required — (Array<String>)

          The identity source to use when mapping a specified attribute to IAM Identity Center.

  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  RelayState: 'STRING_VALUE',
  SessionDuration: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ssoadmin.createPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Description — (String)

    The description of the PermissionSet.

  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • Name — (String)

    The name of the PermissionSet.

  • RelayState — (String)

    Used to redirect users within the application during the federation authentication process.

  • SessionDuration — (String)

    The length of time that the application user sessions are valid in the ISO-8601 standard.

  • Tags — (Array<map>)

    The tags to attach to the new PermissionSet.

    • Key — required — (String)

      The key for the tag.

    • Value — required — (String)

      The value of the tag.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PermissionSet — (map)

      Defines the level of access on an Amazon Web Services account.

      • CreatedDate — (Date)

        The date that the permission set was created.

      • Description — (String)

        The description of the PermissionSet.

      • Name — (String)

        The name of the permission set.

      • PermissionSetArn — (String)

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

      • RelayState — (String)

        Used to redirect users within the application during the federation authentication process.

      • SessionDuration — (String)

        The length of time that the application user sessions are valid for in the ISO-8601 standard.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  TrustedTokenIssuerConfiguration: { /* required */
    OidcJwtConfiguration: {
      ClaimAttributePath: 'STRING_VALUE', /* required */
      IdentityStoreAttributePath: 'STRING_VALUE', /* required */
      IssuerUrl: 'STRING_VALUE', /* required */
      JwksRetrievalOption: OPEN_ID_DISCOVERY /* required */
    }
  },
  TrustedTokenIssuerType: OIDC_JWT, /* required */
  ClientToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
ssoadmin.createTrustedTokenIssuer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ClientToken — (String)

    Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    If a token is not provided, the SDK will use a version 4 UUID.
  • InstanceArn — (String)

    Specifies the ARN of the instance of IAM Identity Center to contain the new trusted token issuer configuration.

  • Name — (String)

    Specifies the name of the new trusted token issuer configuration.

  • Tags — (Array<map>)

    Specifies tags to be attached to the new trusted token issuer configuration.

    • Key — required — (String)

      The key for the tag.

    • Value — required — (String)

      The value of the tag.

  • TrustedTokenIssuerConfiguration — (map)

    Specifies settings that apply to the new trusted token issuer configuration. The settings that are available depend on what TrustedTokenIssuerType you specify.

    • OidcJwtConfiguration — (map)

      A structure that describes the settings for a trusted token issuer that works with OpenID Connect (OIDC) by using JSON Web Tokens (JWT).

      • ClaimAttributePath — required — (String)

        The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

      • IdentityStoreAttributePath — required — (String)

        The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

      • IssuerUrl — required — (String)

        The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.

      • JwksRetrievalOption — required — (String)

        The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.

        Possible values include:
        • "OPEN_ID_DISCOVERY"
  • TrustedTokenIssuerType — (String)

    Specifies the type of the new trusted token issuer.

    Possible values include:
    • "OIDC_JWT"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • TrustedTokenIssuerArn — (String)

      The ARN of the new trusted token issuer configuration.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  PrincipalId: 'STRING_VALUE', /* required */
  PrincipalType: USER | GROUP, /* required */
  TargetId: 'STRING_VALUE', /* required */
  TargetType: AWS_ACCOUNT /* required */
};
ssoadmin.deleteAccountAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • PermissionSetArn — (String)

    The ARN of the permission set that will be used to remove access.

  • PrincipalId — (String)

    An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

  • PrincipalType — (String)

    The entity type for which the assignment will be deleted.

    Possible values include:
    • "USER"
    • "GROUP"
  • TargetId — (String)

    TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

  • TargetType — (String)

    The entity type for which the assignment will be deleted.

    Possible values include:
    • "AWS_ACCOUNT"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountAssignmentDeletionStatus — (map)

      The status object for the account assignment deletion operation.

      • CreatedDate — (Date)

        The date that the permission set was created.

      • FailureReason — (String)

        The message that contains an error or exception in case of an operation failure.

      • PermissionSetArn — (String)

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

      • PrincipalId — (String)

        An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

      • PrincipalType — (String)

        The entity type for which the assignment will be created.

        Possible values include:
        • "USER"
        • "GROUP"
      • RequestId — (String)

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • Status — (String)

        The status of the permission set provisioning process.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "SUCCEEDED"
      • TargetId — (String)

        TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

      • TargetType — (String)

        The entity type for which the assignment will be created.

        Possible values include:
        • "AWS_ACCOUNT"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE' /* required */
};
ssoadmin.deleteApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  Scope: 'STRING_VALUE' /* required */
};
ssoadmin.deleteApplicationAccessScope(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application with the access scope to delete.

  • Scope — (String)

    Specifies the name of the access scope to remove from the application.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  PrincipalId: 'STRING_VALUE', /* required */
  PrincipalType: USER | GROUP /* required */
};
ssoadmin.deleteApplicationAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application.

  • PrincipalId — (String)

    An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

  • PrincipalType — (String)

    The entity type for which the assignment will be deleted.

    Possible values include:
    • "USER"
    • "GROUP"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  AuthenticationMethodType: IAM /* required */
};
ssoadmin.deleteApplicationAuthenticationMethod(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application with the authentication method to delete.

  • AuthenticationMethodType — (String)

    Specifies the authentication method type to delete from the application.

    Possible values include:
    • "IAM"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  GrantType: authorization_code | refresh_token | urn:ietf:params:oauth:grant-type:jwt-bearer | urn:ietf:params:oauth:grant-type:token-exchange /* required */
};
ssoadmin.deleteApplicationGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application with the grant to delete.

  • GrantType — (String)

    Specifies the type of grant to delete from the application.

    Possible values include:
    • "authorization_code"
    • "refresh_token"
    • "urn:ietf:params:oauth:grant-type:jwt-bearer"
    • "urn:ietf:params:oauth:grant-type:token-exchange"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.deleteInlinePolicyFromPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • PermissionSetArn — (String)

    The ARN of the permission set that will be used to remove access.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE' /* required */
};
ssoadmin.deleteInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the instance of IAM Identity Center under which the operation will run.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE' /* required */
};
ssoadmin.deleteInstanceAccessControlAttributeConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.deletePermissionsBoundaryFromPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed.

  • PermissionSetArn — (String)

    The ARN of the PermissionSet.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.deletePermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • PermissionSetArn — (String)

    The ARN of the permission set that should be deleted.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TrustedTokenIssuerArn: 'STRING_VALUE' /* required */
};
ssoadmin.deleteTrustedTokenIssuer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TrustedTokenIssuerArn — (String)

    Specifies the ARN of the trusted token issuer configuration to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountAssignmentCreationRequestId: 'STRING_VALUE', /* required */
  InstanceArn: 'STRING_VALUE' /* required */
};
ssoadmin.describeAccountAssignmentCreationStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountAssignmentCreationRequestId — (String)

    The identifier that is used to track the request operation progress.

  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountAssignmentCreationStatus — (map)

      The status object for the account assignment creation operation.

      • CreatedDate — (Date)

        The date that the permission set was created.

      • FailureReason — (String)

        The message that contains an error or exception in case of an operation failure.

      • PermissionSetArn — (String)

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

      • PrincipalId — (String)

        An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

      • PrincipalType — (String)

        The entity type for which the assignment will be created.

        Possible values include:
        • "USER"
        • "GROUP"
      • RequestId — (String)

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • Status — (String)

        The status of the permission set provisioning process.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "SUCCEEDED"
      • TargetId — (String)

        TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

      • TargetType — (String)

        The entity type for which the assignment will be created.

        Possible values include:
        • "AWS_ACCOUNT"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountAssignmentDeletionRequestId: 'STRING_VALUE', /* required */
  InstanceArn: 'STRING_VALUE' /* required */
};
ssoadmin.describeAccountAssignmentDeletionStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountAssignmentDeletionRequestId — (String)

    The identifier that is used to track the request operation progress.

  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountAssignmentDeletionStatus — (map)

      The status object for the account assignment deletion operation.

      • CreatedDate — (Date)

        The date that the permission set was created.

      • FailureReason — (String)

        The message that contains an error or exception in case of an operation failure.

      • PermissionSetArn — (String)

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

      • PrincipalId — (String)

        An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

      • PrincipalType — (String)

        The entity type for which the assignment will be created.

        Possible values include:
        • "USER"
        • "GROUP"
      • RequestId — (String)

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • Status — (String)

        The status of the permission set provisioning process.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "SUCCEEDED"
      • TargetId — (String)

        TargetID is an Amazon Web Services account identifier, (For example, 123456789012).

      • TargetType — (String)

        The entity type for which the assignment will be created.

        Possible values include:
        • "AWS_ACCOUNT"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE' /* required */
};
ssoadmin.describeApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ApplicationAccount — (String)

      The account ID.

    • ApplicationArn — (String)

      Specifies the ARN of the application.

    • ApplicationProviderArn — (String)

      The ARN of the application provider under which the operation will run.

    • CreatedDate — (Date)

      The date the application was created.

    • Description — (String)

      The description of the .

    • InstanceArn — (String)

      The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    • Name — (String)

      The application name.

    • PortalOptions — (map)

      A structure that describes the options for the portal associated with an application.

      • SignInOptions — (map)

        A structure that describes the sign-in options for the access portal.

        • ApplicationUrl — (String)

          The URL that accepts authentication requests for an application. This is a required parameter if the Origin parameter is APPLICATION.

        • Origin — required — (String)

          This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values:

          • APPLICATION: IAM Identity Center redirects the customer to the configured ApplicationUrl.

          • IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.

          Possible values include:
          • "IDENTITY_CENTER"
          • "APPLICATION"
      • Visibility — (String)

        Indicates whether this application is visible in the access portal.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • Status — (String)

      Specifies whether the application is enabled or disabled.

      Possible values include:
      • "ENABLED"
      • "DISABLED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  PrincipalId: 'STRING_VALUE', /* required */
  PrincipalType: USER | GROUP /* required */
};
ssoadmin.describeApplicationAssignment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • PrincipalId — (String)

    An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

  • PrincipalType — (String)

    The entity type for which the assignment will be created.

    Possible values include:
    • "USER"
    • "GROUP"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ApplicationArn — (String)

      Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    • PrincipalId — (String)

      An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

    • PrincipalType — (String)

      The entity type for which the assignment will be created.

      Possible values include:
      • "USER"
      • "GROUP"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationProviderArn: 'STRING_VALUE' /* required */
};
ssoadmin.describeApplicationProvider(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationProviderArn — (String)

    Specifies the ARN of the application provider for which you want details.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ApplicationProviderArn — (String)

      The ARN of the application provider.

    • DisplayData — (map)

      A structure with details about the display data for the application provider.

      • Description — (String)

        The description of the application provider that appears in the portal.

      • DisplayName — (String)

        The name of the application provider that appears in the portal.

      • IconUrl — (String)

        A URL that points to an icon that represents the application provider.

    • FederationProtocol — (String)

      The protocol used to federate to the application provider.

      Possible values include:
      • "SAML"
      • "OAUTH"
    • ResourceServerConfig — (map)

      A structure with details about the receiving application.

      • Scopes — (map<map>)

        A list of the IAM Identity Center access scopes that are associated with this resource server.

        • DetailedTitle — (String)

          The title of an access scope for a resource server.

        • LongDescription — (String)

          The description of an access scope for a resource server.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE' /* required */
};
ssoadmin.describeInstance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the instance of IAM Identity Center under which the operation will run.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CreatedDate — (Date)

      The date the instance was created.

    • IdentityStoreId — (String)

      The identifier of the identity store that is connected to the instance of IAM Identity Center.

    • InstanceArn — (String)

      The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

    • Name — (String)

      Specifies the instance name.

    • OwnerAccountId — (String)

      The identifier of the Amazon Web Services account for which the instance was created.

    • Status — (String)

      The status of the instance.

      Possible values include:
      • "CREATE_IN_PROGRESS"
      • "DELETE_IN_PROGRESS"
      • "ACTIVE"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE' /* required */
};
ssoadmin.describeInstanceAccessControlAttributeConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InstanceAccessControlAttributeConfiguration — (map)

      Gets the list of IAM Identity Center identity store attributes that have been added to your ABAC configuration.

      • AccessControlAttributes — required — (Array<map>)

        Lists the attributes that are configured for ABAC in the specified IAM Identity Center instance.

        • Key — required — (String)

          The name of the attribute associated with your identities in your identity source. This is used to map a specified attribute in your identity source with an attribute in IAM Identity Center.

        • Value — required — (map)

          The value used for mapping a specified attribute to an identity source.

          • Source — required — (Array<String>)

            The identity source to use when mapping a specified attribute to IAM Identity Center.

    • Status — (String)

      The status of the attribute configuration process.

      Possible values include:
      • "ENABLED"
      • "CREATION_IN_PROGRESS"
      • "CREATION_FAILED"
    • StatusReason — (String)

      Provides more details about the current status of the specified attribute.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.describePermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • PermissionSetArn — (String)

    The ARN of the permission set.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PermissionSet — (map)

      Describes the level of access on an Amazon Web Services account.

      • CreatedDate — (Date)

        The date that the permission set was created.

      • Description — (String)

        The description of the PermissionSet.

      • Name — (String)

        The name of the permission set.

      • PermissionSetArn — (String)

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

      • RelayState — (String)

        Used to redirect users within the application during the federation authentication process.

      • SessionDuration — (String)

        The length of time that the application user sessions are valid for in the ISO-8601 standard.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  ProvisionPermissionSetRequestId: 'STRING_VALUE' /* required */
};
ssoadmin.describePermissionSetProvisioningStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • ProvisionPermissionSetRequestId — (String)

    The identifier that is provided by the ProvisionPermissionSet call to retrieve the current status of the provisioning workflow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PermissionSetProvisioningStatus — (map)

      The status object for the permission set provisioning operation.

      • AccountId — (String)

        The identifier of the Amazon Web Services account from which to list the assignments.

      • CreatedDate — (Date)

        The date that the permission set was created.

      • FailureReason — (String)

        The message that contains an error or exception in case of an operation failure.

      • PermissionSetArn — (String)

        The ARN of the permission set that is being provisioned. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

      • RequestId — (String)

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • Status — (String)

        The status of the permission set provisioning process.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "SUCCEEDED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  TrustedTokenIssuerArn: 'STRING_VALUE' /* required */
};
ssoadmin.describeTrustedTokenIssuer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • TrustedTokenIssuerArn — (String)

    Specifies the ARN of the trusted token issuer configuration that you want details about.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Name — (String)

      The name of the trusted token issuer configuration.

    • TrustedTokenIssuerArn — (String)

      The ARN of the trusted token issuer configuration.

    • TrustedTokenIssuerConfiguration — (map)

      A structure the describes the settings that apply of this trusted token issuer.

      • OidcJwtConfiguration — (map)

        A structure that describes the settings for a trusted token issuer that works with OpenID Connect (OIDC) by using JSON Web Tokens (JWT).

        • ClaimAttributePath — required — (String)

          The path of the source attribute in the JWT from the trusted token issuer. The attribute mapped by this JMESPath expression is compared against the attribute mapped by IdentityStoreAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

        • IdentityStoreAttributePath — required — (String)

          The path of the destination attribute in a JWT from IAM Identity Center. The attribute mapped by this JMESPath expression is compared against the attribute mapped by ClaimAttributePath when a trusted token issuer token is exchanged for an IAM Identity Center token.

        • IssuerUrl — required — (String)

          The URL that IAM Identity Center uses for OpenID Discovery. OpenID Discovery is used to obtain the information required to verify the tokens that the trusted token issuer generates.

        • JwksRetrievalOption — required — (String)

          The method that the trusted token issuer can use to retrieve the JSON Web Key Set used to verify a JWT.

          Possible values include:
          • "OPEN_ID_DISCOVERY"
    • TrustedTokenIssuerType — (String)

      The type of the trusted token issuer.

      Possible values include:
      • "OIDC_JWT"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CustomerManagedPolicyReference: { /* required */
    Name: 'STRING_VALUE', /* required */
    Path: 'STRING_VALUE'
  },
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.detachCustomerManagedPolicyReferenceFromPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CustomerManagedPolicyReference — (map)

    Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

    • Name — required — (String)

      The name of the IAM policy that you have configured in each account where you want to deploy your permission set.

    • Path — (String)

      The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is /. For more information, see Friendly names and paths in the IAM User Guide.

  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed.

  • PermissionSetArn — (String)

    The ARN of the PermissionSet.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  ManagedPolicyArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.detachManagedPolicyFromPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • ManagedPolicyArn — (String)

    The Amazon Web Services managed policy ARN to be detached from a permission set.

  • PermissionSetArn — (String)

    The ARN of the PermissionSet from which the policy should be detached.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  Scope: 'STRING_VALUE' /* required */
};
ssoadmin.getApplicationAccessScope(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application with the access scope that you want to retrieve.

  • Scope — (String)

    Specifies the name of the access scope for which you want the authorized targets.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AuthorizedTargets — (Array<String>)

      An array of authorized targets associated with this access scope.

    • Scope — (String)

      The name of the access scope that can be used with the authorized targets.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE' /* required */
};
ssoadmin.getApplicationAssignmentConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AssignmentRequired — (Boolean)

      If AssignmentsRequired is true (default value), users don’t have access to the application unless an assignment is created using the CreateApplicationAssignment API. If false, all users have access to the application.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  AuthenticationMethodType: IAM /* required */
};
ssoadmin.getApplicationAuthenticationMethod(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application.

  • AuthenticationMethodType — (String)

    Specifies the type of authentication method for which you want details.

    Possible values include:
    • "IAM"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AuthenticationMethod — (map)

      A structure that contains details about the requested authentication method.

      • Iam — (map)

        A structure that describes details for IAM authentication.

        • ActorPolicy — required — (map)

          An IAM policy document in JSON.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  GrantType: authorization_code | refresh_token | urn:ietf:params:oauth:grant-type:jwt-bearer | urn:ietf:params:oauth:grant-type:token-exchange /* required */
};
ssoadmin.getApplicationGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application that contains the grant.

  • GrantType — (String)

    Specifies the type of grant.

    Possible values include:
    • "authorization_code"
    • "refresh_token"
    • "urn:ietf:params:oauth:grant-type:jwt-bearer"
    • "urn:ietf:params:oauth:grant-type:token-exchange"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Grant — (map)

      A structure that describes the requested grant.

      • AuthorizationCode — (map)

        Configuration options for the authorization_code grant type.

        • RedirectUris — (Array<String>)

          A list of URIs that are valid locations to redirect a user's browser after the user is authorized.

      • JwtBearer — (map)

        Configuration options for the urn:ietf:params:oauth:grant-type:jwt-bearer grant type.

        • AuthorizedTokenIssuers — (Array<map>)

          A list of allowed token issuers trusted by the Identity Center instances for this application.

          • AuthorizedAudiences — (Array<String>)

            An array list of authorized audiences, or applications, that can consume the tokens generated by the associated trusted token issuer.

          • TrustedTokenIssuerArn — (String)

            The ARN of the trusted token issuer.

      • RefreshToken — (map)

        Configuration options for the refresh_token grant type.

      • TokenExchange — (map)

        Configuration options for the urn:ietf:params:oauth:grant-type:token-exchange grant type.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.getInlinePolicyForPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • PermissionSetArn — (String)

    The ARN of the permission set.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InlinePolicy — (String)

      The inline policy that is attached to the permission set.

      Note: For Length Constraints, if a valid ARN is provided for a permission set, it is possible for an empty inline policy to be returned.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE' /* required */
};
ssoadmin.getPermissionsBoundaryForPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed.

  • PermissionSetArn — (String)

    The ARN of the PermissionSet.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PermissionsBoundary — (map)

      The permissions boundary attached to the specified permission set.

      • CustomerManagedPolicyReference — (map)

        Specifies the name and path of a customer managed policy. You must have an IAM policy that matches the name and path in each Amazon Web Services account where you want to deploy your permission set.

        • Name — required — (String)

          The name of the IAM policy that you have configured in each account where you want to deploy your permission set.

        • Path — (String)

          The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is /. For more information, see Friendly names and paths in the IAM User Guide.

      • ManagedPolicyArn — (String)

        The Amazon Web Services managed policy ARN that you want to attach to a permission set as a permissions boundary.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  Filter: {
    Status: IN_PROGRESS | FAILED | SUCCEEDED
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listAccountAssignmentCreationStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filter — (map)

    Filters results based on the passed attribute value.

    • Status — (String)

      Filters the list operations result based on the status attribute.

      Possible values include:
      • "IN_PROGRESS"
      • "FAILED"
      • "SUCCEEDED"
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • MaxResults — (Integer)

    The maximum number of results to display for the assignment.

  • NextToken — (String)

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountAssignmentsCreationStatus — (Array<map>)

      The status object for the account assignment creation operation.

      • CreatedDate — (Date)

        The date that the permission set was created.

      • RequestId — (String)

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • Status — (String)

        The status of the permission set provisioning process.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "SUCCEEDED"
    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  Filter: {
    Status: IN_PROGRESS | FAILED | SUCCEEDED
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listAccountAssignmentDeletionStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filter — (map)

    Filters results based on the passed attribute value.

    • Status — (String)

      Filters the list operations result based on the status attribute.

      Possible values include:
      • "IN_PROGRESS"
      • "FAILED"
      • "SUCCEEDED"
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • MaxResults — (Integer)

    The maximum number of results to display for the assignment.

  • NextToken — (String)

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountAssignmentsDeletionStatus — (Array<map>)

      The status object for the account assignment deletion operation.

      • CreatedDate — (Date)

        The date that the permission set was created.

      • RequestId — (String)

        The identifier for tracking the request operation that is generated by the universally unique identifier (UUID) workflow.

      • Status — (String)

        The status of the permission set provisioning process.

        Possible values include:
        • "IN_PROGRESS"
        • "FAILED"
        • "SUCCEEDED"
    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AccountId: 'STRING_VALUE', /* required */
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listAccountAssignments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AccountId — (String)

    The identifier of the Amazon Web Services account from which to list the assignments.

  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • MaxResults — (Integer)

    The maximum number of results to display for the assignment.

  • NextToken — (String)

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

  • PermissionSetArn — (String)

    The ARN of the permission set from which to list assignments.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountAssignments — (Array<map>)

      The list of assignments that match the input Amazon Web Services account and permission set.

      • AccountId — (String)

        The identifier of the Amazon Web Services account.

      • PermissionSetArn — (String)

        The ARN of the permission set. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

      • PrincipalId — (String)

        An identifier for an object in IAM Identity Center, such as a user or group. PrincipalIds are GUIDs (For example, f81d4fae-7dec-11d0-a765-00a0c91e6bf6). For more information about PrincipalIds in IAM Identity Center, see the IAM Identity Center Identity Store API Reference.

      • PrincipalType — (String)

        The entity type for which the assignment will be created.

        Possible values include:
        • "USER"
        • "GROUP"
    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PrincipalId: 'STRING_VALUE', /* required */
  PrincipalType: USER | GROUP, /* required */
  Filter: {
    AccountId: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listAccountAssignmentsForPrincipal(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filter — (map)

    Specifies an Amazon Web Services account ID number. Results are filtered to only those that match this ID number.

    • AccountId — (String)

      The ID number of an Amazon Web Services account that filters the results in the response.

  • InstanceArn — (String)

    Specifies the ARN of the instance of IAM Identity Center that contains the principal.

  • MaxResults — (Integer)

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • NextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • PrincipalId — (String)

    Specifies the principal for which you want to retrieve the list of account assignments.

  • PrincipalType — (String)

    Specifies the type of the principal.

    Possible values include:
    • "USER"
    • "GROUP"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountAssignments — (Array<map>)

      An array list of the account assignments for the principal.

      • AccountId — (String)

        The account ID number of the Amazon Web Services account.

      • PermissionSetArn — (String)

        The ARN of the IAM Identity Center permission set assigned to this principal for this Amazon Web Services account.

      • PrincipalId — (String)

        The ID of the principal.

      • PrincipalType — (String)

        The type of the principal.

        Possible values include:
        • "USER"
        • "GROUP"
    • NextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ProvisioningStatus: LATEST_PERMISSION_SET_PROVISIONED | LATEST_PERMISSION_SET_NOT_PROVISIONED
};
ssoadmin.listAccountsForProvisionedPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • MaxResults — (Integer)

    The maximum number of results to display for the PermissionSet.

  • NextToken — (String)

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

  • PermissionSetArn — (String)

    The ARN of the PermissionSet from which the associated Amazon Web Services accounts will be listed.

  • ProvisioningStatus — (String)

    The permission set provisioning status for an Amazon Web Services account.

    Possible values include:
    • "LATEST_PERMISSION_SET_PROVISIONED"
    • "LATEST_PERMISSION_SET_NOT_PROVISIONED"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AccountIds — (Array<String>)

      The list of Amazon Web Services AccountIds.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listApplicationAccessScopes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application.

  • MaxResults — (Integer)

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • NextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • NextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

    • Scopes — (Array<map>)

      An array list of access scopes and their authorized targets that are associated with the application.

      • AuthorizedTargets — (Array<String>)

        An array list of ARNs of applications.

      • Scope — required — (String)

        The name of the access scope.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listApplicationAssignments(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application.

  • MaxResults — (Integer)

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • NextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ApplicationAssignments — (Array<map>)

      The list of users assigned to an application.

      • ApplicationArn — required — (String)

        The ARN of the application that has principals assigned.

      • PrincipalId — required — (String)

        The unique identifier of the principal assigned to the application.

      • PrincipalType — required — (String)

        The type of the principal assigned to the application.

        Possible values include:
        • "USER"
        • "GROUP"
    • NextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PrincipalId: 'STRING_VALUE', /* required */
  PrincipalType: USER | GROUP, /* required */
  Filter: {
    ApplicationArn: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listApplicationAssignmentsForPrincipal(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filter — (map)

    Filters the output to include only assignments associated with the application that has the specified ARN.

    • ApplicationArn — (String)

      The ARN of an application.

  • InstanceArn — (String)

    Specifies the instance of IAM Identity Center that contains principal and applications.

  • MaxResults — (Integer)

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • NextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • PrincipalId — (String)

    Specifies the unique identifier of the principal for which you want to retrieve its assignments.

  • PrincipalType — (String)

    Specifies the type of the principal for which you want to retrieve its assignments.

    Possible values include:
    • "USER"
    • "GROUP"

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ApplicationAssignments — (Array<map>)

      An array list of the application assignments for the specified principal.

      • ApplicationArn — (String)

        The ARN of the application to which the specified principal is assigned.

      • PrincipalId — (String)

        The unique identifier of the principal assigned to the application.

      • PrincipalType — (String)

        The type of the principal assigned to the application.

        Possible values include:
        • "USER"
        • "GROUP"
    • NextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
ssoadmin.listApplicationAuthenticationMethods(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application with the authentication methods you want to list.

  • NextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AuthenticationMethods — (Array<map>)

      An array list of authentication methods for the specified application.

      • AuthenticationMethod — (map)

        A structure that describes an authentication method. The contents of this structure is determined by the AuthenticationMethodType.

        • Iam — (map)

          A structure that describes details for IAM authentication.

          • ActorPolicy — required — (map)

            An IAM policy document in JSON.

      • AuthenticationMethodType — (String)

        The type of authentication that is used by this method.

        Possible values include:
        • "IAM"
    • NextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ApplicationArn: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
ssoadmin.listApplicationGrants(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ApplicationArn — (String)

    Specifies the ARN of the application whose grants you want to list.

  • NextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Grants — (Array<map>)

      An array list of structures that describe the requested grants.

      • Grant — required — (map)

        The configuration structure for the selected grant.

        • AuthorizationCode — (map)

          Configuration options for the authorization_code grant type.

          • RedirectUris — (Array<String>)

            A list of URIs that are valid locations to redirect a user's browser after the user is authorized.

        • JwtBearer — (map)

          Configuration options for the urn:ietf:params:oauth:grant-type:jwt-bearer grant type.

          • AuthorizedTokenIssuers — (Array<map>)

            A list of allowed token issuers trusted by the Identity Center instances for this application.

            • AuthorizedAudiences — (Array<String>)

              An array list of authorized audiences, or applications, that can consume the tokens generated by the associated trusted token issuer.

            • TrustedTokenIssuerArn — (String)

              The ARN of the trusted token issuer.

        • RefreshToken — (map)

          Configuration options for the refresh_token grant type.

        • TokenExchange — (map)

          Configuration options for the urn:ietf:params:oauth:grant-type:token-exchange grant type.

      • GrantType — required — (String)

        The type of the selected grant.

        Possible values include:
        • "authorization_code"
        • "refresh_token"
        • "urn:ietf:params:oauth:grant-type:jwt-bearer"
        • "urn:ietf:params:oauth:grant-type:token-exchange"
    • NextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listApplicationProviders(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MaxResults — (Integer)

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • NextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • ApplicationProviders — (Array<map>)

      An array list of structures that describe application providers.

      • ApplicationProviderArn — required — (String)

        The ARN of the application provider.

      • DisplayData — (map)

        A structure that describes how IAM Identity Center represents the application provider in the portal.

        • Description — (String)

          The description of the application provider that appears in the portal.

        • DisplayName — (String)

          The name of the application provider that appears in the portal.

        • IconUrl — (String)

          A URL that points to an icon that represents the application provider.

      • FederationProtocol — (String)

        The protocol that the application provider uses to perform federation.

        Possible values include:
        • "SAML"
        • "OAUTH"
      • ResourceServerConfig — (map)

        A structure that describes the application provider's resource server.

        • Scopes — (map<map>)

          A list of the IAM Identity Center access scopes that are associated with this resource server.

          • DetailedTitle — (String)

            The title of an access scope for a resource server.

          • LongDescription — (String)

            The description of an access scope for a resource server.

    • NextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  Filter: {
    ApplicationAccount: 'STRING_VALUE',
    ApplicationProvider: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listApplications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • Filter — (map)

    Filters response results.

    • ApplicationAccount — (String)

      An Amazon Web Services account ID number that filters the results in the response.

    • ApplicationProvider — (String)

      The ARN of an application provider that can filter the results in the response.

  • InstanceArn — (String)

    The ARN of the IAM Identity Center application under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

  • MaxResults — (Integer)

    Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • NextToken — (String)

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Applications — (Array<map>)

      Retrieves all applications associated with the instance.

      • ApplicationAccount — (String)

        The Amazon Web Services account ID number of the application.

      • ApplicationArn — (String)

        The ARN of the application.

      • ApplicationProviderArn — (String)

        The ARN of the application provider for this application.

      • CreatedDate — (Date)

        The date and time when the application was originally created.

      • Description — (String)

        The description of the application.

      • InstanceArn — (String)

        The ARN of the instance of IAM Identity Center that is configured with this application.

      • Name — (String)

        The name of the application.

      • PortalOptions — (map)

        A structure that describes the options for the access portal associated with this application.

        • SignInOptions — (map)

          A structure that describes the sign-in options for the access portal.

          • ApplicationUrl — (String)

            The URL that accepts authentication requests for an application. This is a required parameter if the Origin parameter is APPLICATION.

          • Origin — required — (String)

            This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values:

            • APPLICATION: IAM Identity Center redirects the customer to the configured ApplicationUrl.

            • IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.

            Possible values include:
            • "IDENTITY_CENTER"
            • "APPLICATION"
        • Visibility — (String)

          Indicates whether this application is visible in the access portal.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • Status — (String)

        The current status of the application in this instance of IAM Identity Center.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • NextToken — (String)

      If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  InstanceArn: 'STRING_VALUE', /* required */
  PermissionSetArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listCustomerManagedPolicyReferencesInPermissionSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • InstanceArn — (String)

    The ARN of the IAM Identity Center instance under which the operation will be executed.

  • MaxResults — (Integer)

    The maximum number of results to display for the list call.

  • NextToken — (String)

    The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

  • PermissionSetArn — (String)

    The ARN of the PermissionSet.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CustomerManagedPolicyReferences — (Array<map>)

      Specifies the names and paths of the customer managed policies that you have attached to your permission set.

      • Name — required — (String)

        The name of the IAM policy that you have configured in each account where you want to deploy your permission set.

      • Path — (String)

        The path to the IAM policy that you have configured in each account where you want to deploy your permission set. The default is /. For more information, see Friendly names and paths in the IAM User Guide.

    • NextToken — (String)

      The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssoadmin.listInstances(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters: