Akamai: Akamai MFA API
Provide secondary authentication to cloud, on-premises, web-based, SaaS, and IaaS applications.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Provide secondary authentication to cloud, on-premises, web-based,
SaaS, and IaaS applications.
Endpoints 23
Email enrollments
- POSTSend enrollment email
/email-enrollments?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXSend enrollment email to a set of new users inviting them to Akamai MFA. This operation provides users with unique links to enroll and activate authentication…
Groups
- GETList groups
/groups?page=2&page_size=50&contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXList groups configured in Akamai MFA, optionally filtered and paginated. - POSTAdd a group
/groups?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXCreate a new group. - GETGet a group
/groups/:groupId?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXRetrieve a group's details. - DELETEDelete a group
/groups/:groupId?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXPermanently delete a group. - POSTAdd a user to a group
/groups/:groupId/users/:userId?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXAdd a user to a group. - DELETERemove a user from a group
/groups/:groupId/users/:userId?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXRemove a user from a group. - POSTAssign groups
/users/:userId/assign-groups?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXAssign a set of groups to a user account. With this operation you can modify the users' group assignment when their role in the organization changes. After…
Users
- GETList users
/users?page=2&pageSize=50&status=ACTIVE&includeDevices=true&policyId=policy_4HZnCV&policyName=Policy-A&contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXList user accounts configured in Akamai MFA, optionally filtered and paginated. - POSTAdd a user
/users?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXCreate a new user. - GETGet a user
/users/:userId?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXGet details about a specific user account, including the userId, status, and username. It also lists the alias information and groups that the user belongs to. - PUTUpdate a user
/users/:userId?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXModify a user's basic information. To add an alias or assign a group to a user, run the Add an alias to a user and Assign groups operations. - DELETEDelete a user
/users/:userId?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXPermanently delete a specific user account. You can delete any active user account from your Akamai MFA service. For manually added users, deleting means…
User aliases
- POSTAdd an alias to a user
/users/:userId/aliases?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXAdd an alternative username for a user. - DELETEDelete an alias assigned to a user
/users/:userId/aliases/:userAliasId?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXPermanently delete a user's alias.
Policies
- POSTAssign policies
/users/:userId/assign-policies?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXAssign a set of policies to a user account. With this operation you can modify the users' access privileges when their role in the organization changes. After…
Bypass codes
- GETList bypass codes
/users/:userId/bypass-codes?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXList all the bypass codes generated for a specific user account. - POSTCreate a bypass code
/users/:userId/bypass-codes?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXGenerate a new bypass code for a specific user account. - GETGet a bypass code
/users/:userId/bypass-codes/:bypassCodeId?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXGet a specific bypass code.
Devices
- GETList the user's devices
/users/:userId/devices?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXList all the user's authentication devices. - POSTAssign a hardware token
/users/:userId/devices/assign-hardware-token?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXAssign a hardware token to a specific user account. To assign a hardware token, you need the token's serial number. You can also unassign and reassign a… - POSTDisable a device
/users/:userId/devices/:deviceId/disable?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXDeactivate the user's authentication device. - POSTEnable a device
/users/:userId/devices/:deviceId/enable?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUXActivate the user's authentication device.
API details
- Base URL
https://{hostname}/amfa/v1- Authentication
- None declared in the description
- Operations
- 23 operations on 16 pathsPOST 11GET 7DELETE 4PUT 1
- Main resources
- Groups 7Users 5Devices 4Bypass codes 3User aliases 2Email enrollments 1Policies 1
- Response formats
application/problem+jsonapplication/json- Description format
- OpenAPI 3.0.0, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Akamai's published OpenAPI description (akamai/akamai-apis) (Apache-2.0)
How to test the Akamai: Akamai MFA API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Akamai MFA API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Send enrollment email” (POST /email-enrollments?contractId=C-0N7RAC71&accountSwitchKey=1-5C0YLB:1-8BYUX), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Akamai: Akamai MFA API?
Provide secondary authentication to cloud, on-premises, web-based, SaaS, and IaaS applications. It is listed under Developer tools and has 23 endpoints.
Who publishes the Akamai: Akamai MFA API?
It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Akamai: Akamai MFA API?
Requests go to https://{hostname}/amfa/v1. Endpoint paths are added to this base URL.
How do I authenticate with the Akamai: Akamai MFA API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Akamai: Akamai MFA API have?
23 operations on 16 paths (11 POST, 7 GET, 4 DELETE, 1 PUT). The largest groups are Groups, Users, Devices, Bypass codes.
Is forking the Akamai: Akamai MFA API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.