API

Akamai MFA API
API summary
Open API schema
Get started
- Set up your API token
API concepts
Errors
- 400
- 401
- 403
- 404
- 500

Email enrollments

Email enrollments
- Send enrollment emailpost

Users

Users
User aliases
- Add an alias to a userpost
- Delete an alias assigned to a userdelete
Groups
- Assign groupspost
Policies
- Assign policiespost
Bypass codes
Devices

Groups

Groups

Get a group

get https://{hostname}/amfa/v1/groups/{groupId}

Retrieve a group's details.

Path Params

groupId

string

required

A unique identifier for the group.

Query Params

contractId

string

required

Unique identifier for the contract.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Responses

Response body

object

createdDate

date-time

required

ISO 8601 timestamp marking when the group was created.

groupId

string

required

length ≥ 1

Unique identifier for the group.

groupName

string

required

length ≥ 1

Descriptive label for the group.

modifiedDate

date-time

required

ISO 8601 timestamp marking when the group was last modified.

summary

string

length ≥ 0

Summary of the group. Indicates what the group represents.

usersCount

integer

required

≥ 0

The total number of users within the group.

Response body

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

errors

array of objects

length ≥ 0

For errors with more than one detected problem, this represents each as a nested Problem Details object.

errors

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

instance

string

length ≥ 1

Unique value generated with each API call.

status

integer

100 to 600

The HTTP status code that categorizes this error case.

title

string

required

length ≥ 1

A summary of each error case.

type

string

required

Identifies each error case.

instance

string

required

length ≥ 1

Unique value generated with each API call.

title

string

required

length ≥ 1

A summary of each error case.

type

string

required

Identifies each error case.

Response body

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

errors

array of objects

length ≥ 0

For errors with more than one detected problem, this represents each as a nested Problem Details object.

errors

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

instance

string

length ≥ 1

Unique value generated with each API call.

status

integer

100 to 600

The HTTP status code that categorizes this error case.

title

string

required

length ≥ 1

A summary of each error case.

type

string

required

Identifies each error case.

instance

string

required

length ≥ 1

Unique value generated with each API call.

title

string

required

length ≥ 1

A summary of each error case.

type

string

required

Identifies each error case.

Response body

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

errors

array of objects

length ≥ 0

For errors with more than one detected problem, this represents each as a nested Problem Details object.

errors

object

detail

string

required

length ≥ 1

Diagnostic instructions to locate and fix the problem.

instance

string

length ≥ 1

Unique value generated with each API call.

status

integer

100 to 600

The HTTP status code that categorizes this error case.

title

string

required

length ≥ 1

A summary of each error case.

type

string

required

Identifies each error case.

instance

string

required

length ≥ 1

Unique value generated with each API call.

title

string

required

length ≥ 1

A summary of each error case.

type

string

required

Identifies each error case.

Updated 9 months ago

List groups

Delete a group

Did this page help you?

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/amfa/v1/groups/groupId \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
{
2
  "createdDate": "2021-10-05T19:46:26.909+00:00",
3
  "groupId": "group_5PzsV2iwFgugE51YdbCPd9",
4
  "groupName": "Portal users group",
5
  "modifiedDate": "2021-10-05T19:46:26.909+00:00",
6
  "usersCount": 0
7
}

Updated 9 months ago

List groups

Delete a group

Did this page help you?

API
Akamai MFA API
API summary
Get started
API concepts
Errors
500
404
403
401
400

Email enrollments
Email enrollments
Send enrollment emailpost

Users
Users
Delete a userdelete
Update a userput
Get a userget
List usersget
Add a userpost
User aliases
Delete an alias assigned to a userdelete
Add an alias to a userpost
Groups
Assign groupspost
Policies
Assign policiespost
Bypass codes
Get a bypass codeget
List bypass codesget
Create a bypass codepost
Devices
Enable a devicepost
Disable a devicepost
Assign a hardware tokenpost
List the user's devicesget

Groups
Groups
Remove a user from a groupdelete
Add a user to a grouppost
Delete a groupdelete
Get a groupget
List groupsget
Add a grouppost

200The response provides the group's details.

401Unauthorized.

404Not found.

500Internal server error.