Use our PowerShell module to manage your access and permissions.

Create groups

Nest groups within each other starting from your account's main parent groups to better scope access to your account's products.

  • Parent groups can have multiple children and have access to everything a child group does.
  • Product access cannot straddle two parents. Child groups belong to a single parent
  • Initially, a child group will have the same access as its parent, but because you can edit and make limitations to reduce or restrict product access, a child may not have the same access as its parent.
  • Child groups can become parent groups.

  1. Get a list of your group IDs to find a parent group's ID. Running the command without parameters returns all groups for your account in a JSON string. To get a flattened list, use the -Flatten switch.

    $ Get-IAMGroup
    
    groupId      : 12345
    groupName    : My parent group
    subGroups    : {@{groupId=98765; groupName=My child group; parentGroupId=12345; 
                  subGroups=System.Object[]; createdDate=4/28/2023 12:00:00 AM; 
                  createdBy=Akamai; modifiedDate=4/30/2023 05:00:46 AM; 
                  modifiedBy=Akamai}, @{groupId=56789; groupName=My second child; parentGroupId=12345; subGroups=System.Object[]; 
                  createdDate=5/20/2023 7:59:09 PM; createdBy=Akamai; 
                  modifiedDate=5/20/2023 10:23:16 PM; modifiedBy=Akamai}}
    createdDate  : 4/28/2023 12:00:00 AM
    createdBy    : aadhikar
    modifiedDate : 4/30/2023 05:00:46 AM
    modifiedBy   : Akamai
    
    groupId       : 98765
    groupName     : My child group
    parentGroupId : 12345
    subGroups     : {}
    createdDate   : 4/28/2012 12:00:00 AM
    createdBy     : Akamai
    modifiedDate  : 4/30/2023 05:00:46 AM
    modifiedBy    : Akamai
    groupId       : 56789
    groupName     : My second child group
    parentGroupId : 18385
    subGroups     : {}
    createdDate   : 5/20/2023 7:59:09 PM
    createdBy     : Akamai
    modifiedDate  : 5/20/2023 10:23:16 PM
    modifiedBy    : Akamai
    
  2. Create a child group using one of your group IDs as a parent and a human-readable name for your new group.

    $ New-IAMGroup -ParentGroupID 12345 -GroupName "My new group" 
    
    groupId       : 23456
    groupName     : My new group
    parentGroupId : 123456
    subGroups     : {}
    createdDate   : 4/28/2023 12:00:00 AM
    createdBy     : jsmith
    modifiedDate  : 4/28/2023 12:00:00 AM
    modifiedBy    : jsmith
    

Update your credentials

Update the description, expiration date, or the status of your credentials.

  • Expiry must be within 24 months
  • Status options are ACTIVE, INACTIVE, or DELETED.
$ Set-IAMAPICredential -Self -credentialID "12345" -ExpireOn "2024-10-11T23:06:59.000Z" -status "ACTIVE" -description "Update expiry"
status expiresOn              description
------ ---------              -----------
ACTIVE 10/11/2024 11:06:59 PM Update expiry

Change notification settings

Update if or when you're notified of changes.

  1. Use the notifications switch to get your profile's notification settings.

    $ Get-IAMUserProfile  -Notifications
    
    uiIdentityId                       : A-BC-1234567
    firstName                          : John
    lastName                           : Smith
    uiUserName                         : jsmith
    email                              : jsmith@example.com
    accountId                          : A-CCT1234
    phone                              : (617) 555-1234
    timeZone                           : GMT-4
    lastLoginDate                      : 9/19/2023 1:44:45 PM
    tfaEnabled                         : True
    additionalAuthentication           : TFA
    preferredLanguage                  : English
    sessionTimeOut                     : 64800
    passwordExpiryDate                 : 11/6/2024 5:46:24 PM
    mobilePhone                        : (617) 555-1234
    address                            : 1234 Main Street
    city                               : Boston
    state                              : MA
    zipCode                            : 02111
    country                            : USA
    jobTitle                           : Devops Lead
    notifications                      : {@{enableEmailNotifications=True; 
                                        options=@{newUserNotification = True; passwordExpiry = True; proactive=@(); upgrade = @()}}}
    tfaConfigured                      : True
    additionalAuthenticationConfigured : TFA
    isLocked                           : False
    
  2. To change your notification settings, pass either the options object, the enablement parameter, or both as a variable or a JSON string.

    $body = @{
      options = @{
        newUserNotification = true
        passwordExpiry = true
        proactive = @( "EdgeScape","EdgeSuite (HTTP Content Delivery)"
        )
        upgrade = @("NetStorage","Other Upgrade Notifications (Planned)")
      }
      enableEmailNotifications = true
    }
    
    $ Set-IAMUserNotifications -Body $body
    
    $ Set-IAMUserNotifications -Body '{@{"options": {"newUserNotification": true, "passwordExpiry": true, "proactive": ["EdgeScape", "EdgeSuite (HTTP Content Delivery)"], "upgrade": ["NetStorage", "Other Upgrade Notifications (Planned)"], "enableEmailNotifications": true}}'
    
    Name                           Value
    ----                           -----
    newUserNotification            True
    passwordExpiry                 True
    proactive                      {EdgeScape, EdgeSuite (HTTP Content Delivery)}
    ipgrade                        {NetStorage, Other Upgrade Notifications (Planned)}