{ "components": { "parameters": { "contract-id-required": { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } } }, "responses": { "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "schemas": { "assign-users": { "additionalProperties": false, "description": "Specifies a list of users to send enrollment emails.", "properties": { "userIds": { "description": "A set of users to send enrollment emails.", "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "userIds" ], "type": "object", "x-akamai": { "file-path": "schemas/assign-users.yaml" } }, "nonEmptyString": { "minLength": 1, "type": "string" }, "problem": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } }, "problem-nested": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } } } }, "externalDocs": { "description": "See documentation for Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference" }, "info": { "description": "Provide secondary authentication to cloud, on-premises, web-based,\nSaaS, and IaaS applications.\n", "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "title": "Akamai: Akamai MFA API", "version": "v1" }, "openapi": "3.0.0", "paths": { "/email-enrollments": { "post": { "description": "Send 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 devices in Akamai MFA.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/post-send-enrollment-email" }, "operationId": "post-send-enrollment-email", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "userIds": [ "user_5JmO0b2SZMrc72a2C8A25R" ] }, "schema": { "additionalProperties": false, "description": "Specifies a list of users to send enrollment emails.", "properties": { "userIds": { "description": "A set of users to send enrollment emails.", "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "userIds" ], "type": "object", "x-akamai": { "file-path": "schemas/assign-users.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "userIds": [ "user_5JmO0b2SZMrc72a2C8A25R" ] }, "schema": { "additionalProperties": false, "description": "Specifies a list of users to send enrollment emails.", "properties": { "userIds": { "description": "A set of users to send enrollment emails.", "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": "array" } }, "required": [ "userIds" ], "type": "object", "x-akamai": { "file-path": "schemas/assign-users.yaml" } } } }, "description": "The enrollment email was successfully sent to the users." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Send enrollment email", "tags": [ "Email enrollments" ] }, "x-akamai": { "file-path": "paths/email-enrollments.yaml", "path-info": "/email-enrollments" } }, "/groups": { "post": { "description": "Create a new group.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/post-group" }, "operationId": "post-group", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "groupName": "Portal Users", "summary": "Users who have access to the internal portal" }, "schema": { "additionalProperties": false, "description": "Add user request JSON.", "properties": { "groupName": { "description": "Descriptive label for the group.", "minLength": 1, "type": "string" }, "summary": { "description": "Summary of the group. Indicates what the group represents.", "minLength": 0, "type": "string" } }, "required": [ "groupName" ], "type": "object", "x-akamai": { "file-path": "schemas/add-group-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "createdDate": "2021-10-05T19:46:26.909+00:00", "groupId": "group_5PzsV2iwFgugE51YdbCPd9", "groupName": "Portal users group", "modifiedDate": "2021-10-05T19:46:26.909+00:00", "usersCount": 0 }, "schema": { "additionalProperties": false, "description": "Specifies a group's basic details.", "properties": { "createdDate": { "description": "ISO 8601 timestamp marking when the group was created.", "format": "date-time", "type": "string" }, "groupId": { "description": "Unique identifier for the group.", "minLength": 1, "type": "string" }, "groupName": { "description": "Descriptive label for the group.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the group was last modified.", "format": "date-time", "type": "string" }, "summary": { "description": "Summary of the group. Indicates what the group represents.", "minLength": 0, "type": "string" }, "usersCount": { "description": "The total number of users within the group.", "minimum": 0, "type": "integer" } }, "required": [ "groupId", "groupName", "usersCount", "createdDate", "modifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/group-detail.yaml" } } } }, "description": "Group successfully created." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Add a group", "tags": [ "Groups" ] }, "get": { "description": "List groups configured in Akamai MFA, optionally filtered and paginated.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/get-groups" }, "operationId": "get-groups", "parameters": [ { "description": "The page number index starting at the default value of `1`.", "in": "query", "name": "page", "schema": { "default": 1, "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-query.yaml" } }, { "description": "The number of records displayed on each page.", "in": "query", "name": "page_size", "schema": { "example": 50, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-size-query.yaml" } }, { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "page": [ { "createdDate": "2021-10-05T19:46:26.909+00:00", "groupId": "group_5PzsV2iwFgugE51YdbCPd9", "groupName": "Portal Users", "modifiedDate": "2021-10-05T19:46:26.909+00:00", "summary": "Users who have access to the internal portal", "usersCount": 5 }, { "createdDate": "2021-10-05T19:46:26.909+00:00", "groupId": "group_7AzsV2iwFgugE51YdbCPB9", "groupName": "Portal Admin Users", "modifiedDate": "2021-10-05T19:46:26.909+00:00", "summary": "Users who have admin access to the internal portal", "usersCount": 5 } ], "totalItemCount": 15, "totalPageCount": 1 }, "schema": { "additionalProperties": false, "description": "Provides response data with a list of groups configured in Akamai MFA.", "properties": { "page": { "description": "A paged list of groups configured in Akamai MFA.", "items": { "additionalProperties": false, "description": "Specifies a group's basic details.", "properties": { "createdDate": { "description": "ISO 8601 timestamp marking when the group was created.", "format": "date-time", "type": "string" }, "groupId": { "description": "Unique identifier for the group.", "minLength": 1, "type": "string" }, "groupName": { "description": "Descriptive label for the group.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the group was last modified.", "format": "date-time", "type": "string" }, "summary": { "description": "Summary of the group. Indicates what the group represents.", "minLength": 0, "type": "string" }, "usersCount": { "description": "The total number of users within the group.", "minimum": 0, "type": "integer" } }, "required": [ "groupId", "groupName", "usersCount", "createdDate", "modifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/group-detail.yaml" } }, "minItems": 0, "type": "array" }, "totalItemCount": { "description": "The total number of groups.", "minimum": 0, "type": "integer" }, "totalPageCount": { "description": "The total number of pages.", "minimum": 0, "type": "integer" } }, "required": [ "page", "totalItemCount", "totalPageCount" ], "type": "object", "x-akamai": { "file-path": "schemas/groups-get-200.yaml" } } } }, "description": "The response lists available groups." }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "List groups", "tags": [ "Groups" ] }, "x-akamai": { "file-path": "paths/groups.yaml", "path-info": "/groups" } }, "/groups/{groupId}": { "get": { "description": "Retrieve a group's details.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/get-group" }, "operationId": "get-group", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "createdDate": "2021-10-05T19:46:26.909+00:00", "groupId": "group_5PzsV2iwFgugE51YdbCPd9", "groupName": "Portal users group", "modifiedDate": "2021-10-05T19:46:26.909+00:00", "usersCount": 0 }, "schema": { "additionalProperties": false, "description": "Specifies a group's basic details.", "properties": { "createdDate": { "description": "ISO 8601 timestamp marking when the group was created.", "format": "date-time", "type": "string" }, "groupId": { "description": "Unique identifier for the group.", "minLength": 1, "type": "string" }, "groupName": { "description": "Descriptive label for the group.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the group was last modified.", "format": "date-time", "type": "string" }, "summary": { "description": "Summary of the group. Indicates what the group represents.", "minLength": 0, "type": "string" }, "usersCount": { "description": "The total number of users within the group.", "minimum": 0, "type": "integer" } }, "required": [ "groupId", "groupName", "usersCount", "createdDate", "modifiedDate" ], "type": "object", "x-akamai": { "file-path": "schemas/group-detail.yaml" } } } }, "description": "The response provides the group's details." }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Get a group", "tags": [ "Groups" ] }, "delete": { "description": "Permanently delete a group.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/delete-group" }, "operationId": "delete-group", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Group successfully deleted. " }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Delete a group", "tags": [ "Groups" ] }, "parameters": [ { "description": "A unique identifier for the group.", "in": "path", "name": "groupId", "required": true, "schema": { "example": "group_67AB4", "type": "string" }, "x-akamai": { "file-path": "parameters/group-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/group.yaml", "path-info": "/groups/{groupId}" } }, "/groups/{groupId}/users/{userId}": { "post": { "description": "Add a user to a group.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/post-user-to-group" }, "operationId": "post-user-to-group", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "User successfully added to the group." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Add a user to a group", "tags": [ "Groups" ] }, "delete": { "description": "Remove a user from a group.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/delete-user-from-group" }, "operationId": "delete-user-from-group", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "User successfully removed from the group." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Remove a user from a group", "tags": [ "Groups" ] }, "parameters": [ { "description": "A unique identifier for the group.", "in": "path", "name": "groupId", "required": true, "schema": { "example": "group_67AB4", "type": "string" }, "x-akamai": { "file-path": "parameters/group-id-path.yaml" } }, { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/user-per-group.yaml", "path-info": "/groups/{groupId}/users/{userId}" } }, "/users": { "post": { "description": "Create a new user.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/post-user" }, "operationId": "post-user", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "email": "afero@example.com", "firstName": "John", "lastName": "Doe", "username": "szhang" }, "schema": { "additionalProperties": false, "description": "Add user request JSON.", "properties": { "email": { "description": "The user's email address.", "minLength": 1, "type": "string" }, "firstName": { "description": "The user's first name.", "minLength": 1, "type": "string" }, "lastName": { "description": "The user's last name.", "minLength": 1, "type": "string" }, "username": { "description": "The user's username. The username is unique for the tenant.", "minLength": 1, "type": "string" } }, "required": [ "username" ], "type": "object", "x-akamai": { "file-path": "schemas/add-user-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "aliases": [ { "alias": "johndoe", "aliasId": "alias_2DveJ9HKmURNmKrz3EOxWZ", "createdDate": "2021-10-21T04:04:46.309+00:00", "modifiedDate": "2021-10-21T04:04:46.309+00:00" }, { "alias": "john_doe", "aliasId": "alias_6AWYrzkzVOfLPIF2iQRBFe", "createdDate": "2021-10-21T04:04:46.505+00:00", "modifiedDate": "2021-10-21T04:04:46.505+00:00" } ], "createdDate": "2021-10-21T04:03:30.678+00:00", "deviceCount": 1, "email": "mrossi@example.com", "firstName": "John", "groups": [ { "groupId": "group_5PzsV2iwFgugE51YdbCPd9", "groupName": "admins", "summary": "Group with admin access to acme resources" }, { "groupId": "group_7AzsV2iwFgugE51YdbCPB9", "groupName": "sales", "summary": "Group for Sales users" } ], "importSource": { "id": "scim_1787", "type": "SCIM" }, "lastName": "Doe", "modifiedDate": "2021-10-21T04:04:45.091+00:00", "userId": "user_2eVKpVVpgzM3fPWsao3sbh", "userStatus": "ACTIVE", "username": "asingh" }, "schema": { "additionalProperties": false, "description": "Provides response data for a specific user.", "properties": { "aliases": { "description": "The user's alternate names.", "items": { "additionalProperties": false, "description": "Specifies details for a user's alias.", "properties": { "alias": { "description": "Alternate usernames for the user.", "minLength": 1, "type": "string" }, "aliasId": { "description": "A unique identifier for the user's alternate username.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking when the alias was created.", "format": "date-time", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the alias was last modified.", "format": "date-time", "type": "string" } }, "required": [ "aliasId", "alias", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/user-alias.yaml" } }, "minItems": 0, "type": "array" }, "createdDate": { "description": "ISO 8601 timestamp marking when the user account was created.", "format": "date-time", "type": "string" }, "deviceCount": { "description": "The number of authentication devices enrolled by the user in Akamai MFA. The user can enroll and use a set of authentication devices. The supported device types include the following: `PUSH`. Any device that supports sending push notifications, for example, tablets and smartphones. `PHONE_ONLY`. A non-smartphone mobile device that supports only text messages and calls. `SECURITY_KEY`. A FIDO2 WebAuthn security key such as a YubiKey or Akamai MFA phone security key. `TOTP`. A hardware device that generates one-time passcodes. `HARDWARE_TOKEN`. A security device that generates one-time passcodes.", "minimum": 0, "type": "integer" }, "devices": { "description": "Authentication devices the user enrolled in Akamai MFA.", "items": { "additionalProperties": false, "description": "Provides response data for a specific user device.", "properties": { "createdDate": { "description": "ISO 8601 timestamp marking when the device was created.", "format": "date-time", "type": "string" }, "deviceId": { "description": "Uniquely identifies the authentication device enrolled by the user.", "minLength": 1, "type": "string" }, "deviceName": { "description": "A user-friendly name to identify the authentication device.", "minLength": 1, "type": "string" }, "deviceType": { "description": "A user's type of authentication device. Refer to [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts) to learn about device types.", "enum": [ "AKAMAI_AUTHENTICATOR", "BYPASS_CODE", "EMAIL_ADDRESS", "GENERIC_WEBAUTHN", "HARDWARE_TOKEN", "PASSKEY", "PHONE_NUMBER", "PLATFORM_AUTHENTICATOR", "REMEMBER_CLIENT", "SECURITY_KEY", "THIRD_PARTY_AUTHENTICATOR" ], "type": "string" }, "isDeviceEnabled": { "description": "Whether the authentication device is enabled in Akamai MFA. You can disable a user's device that remains inactive or poses a threat to your data. Users can't use a deactivated device to confirm their identity. Disabling a device is reversible, and isn't the same as permanently deleting a device. See [Enable a device](https://techdocs.akamai.com/mfa/reference/post-enable-user-device) and [Disable a device](https://techdocs.akamai.com/mfa/reference/post-disable-user-device) for details on how to manage user devices.", "type": "boolean" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the device was last modified, or when it was last used since then.", "format": "date-time", "type": "string" }, "platform": { "description": "The platform of the authentication device.", "minLength": 1, "type": "string" } }, "required": [ "deviceId", "deviceType", "platform", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/device.yaml" } }, "minItems": 0, "type": "array" }, "email": { "description": "The user's email address.", "minLength": 1, "type": "string" }, "firstName": { "description": "The user's first name.", "minLength": 1, "type": "string" }, "groups": { "description": "Lists the user's group memberships.", "items": { "additionalProperties": false, "properties": { "groupId": { "description": "Unique identifier for the group.", "minLength": 1, "type": "string" }, "groupName": { "description": "Descriptive label for the group.", "minLength": 1, "type": "string" }, "summary": { "description": "Summary of the group. Indicates what the group represents.", "minLength": 0, "type": "string" } }, "required": [ "groupId", "groupName" ], "type": "object", "x-akamai": { "file-path": "schemas/user-group.yaml" } }, "minItems": 0, "type": "array" }, "importSource": { "additionalProperties": false, "description": "The imported user's provisioning source. A `null` value marks manually imported users.", "nullable": true, "properties": { "id": { "description": "A unique identifier for the imported user's provisioning source.", "minLength": 1, "type": "string" }, "type": { "description": "The imported user's provisioning source, either `SCIM` or `EAA`.", "enum": [ "SCIM", "EAA" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/user-source.yaml" } }, "lastName": { "description": "The user's last name.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the user account was last modified.", "format": "date-time", "type": "string" }, "userId": { "description": "A unique identifier for each user account.", "minLength": 1, "type": "string" }, "userStatus": { "description": "The status of the user account, either `ACTIVE`, `UNENROLLED`, `DEVICES_DISABLED`, or `PROVISIONING_DISABLED`. Refer to [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts) to learn more about user account status.", "enum": [ "ACTIVE", "UNENROLLED", "DEVICES_DISABLED", "PROVISIONING_DISABLED" ], "type": "string" }, "username": { "description": "The user's username. The username is unique for the tenant.", "minLength": 1, "type": "string" } }, "required": [ "userId", "username", "userStatus", "deviceCount", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/user-detail.yaml" } } } }, "description": "User successfully created." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Add a user", "tags": [ "Users" ] }, "get": { "description": "List user accounts configured in Akamai MFA, optionally filtered and paginated.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/get-users" }, "operationId": "get-users", "parameters": [ { "description": "The page number index starting at the default value of `1`.", "in": "query", "name": "page", "schema": { "default": 1, "example": 2, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-query.yaml" } }, { "description": "The number of records displayed on each page. The default value is `25`.", "in": "query", "name": "pageSize", "schema": { "default": 25, "example": 50, "type": "integer" }, "x-akamai": { "file-path": "parameters/page-size-query-optional.yaml" } }, { "description": "__Enum__ Filter user records by the specific status and display a list of user accounts that have this status.", "in": "query", "name": "status", "required": false, "schema": { "enum": [ "ACTIVE", "UNENROLLED", "DEVICES_DISABLED", "PROVISIONING_DISABLED" ], "example": "ACTIVE", "type": "string" }, "x-akamai": { "file-path": "parameters/user-status-query-optional.yaml" } }, { "description": "Whether the response should include device details for listed users. The default value is `false`.", "in": "query", "name": "includeDevices", "schema": { "default": false, "example": true, "type": "boolean" }, "x-akamai": { "file-path": "parameters/include-devices-optional.yaml" } }, { "description": "Optionally filter users subject to a specific policy.", "in": "query", "name": "policyId", "required": false, "schema": { "example": "policy_4HZnCV", "type": "string" }, "x-akamai": { "file-path": "parameters/policy-id-query-optional.yaml" } }, { "description": "Optionally filter users subject to a specific policy, referred to by name.", "in": "query", "name": "policyName", "required": false, "schema": { "example": "Policy-A", "type": "string" }, "x-akamai": { "file-path": "parameters/policy-name-query-optional.yaml" } }, { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "totalItems": 50, "totalPages": 2, "users": [ { "aliases": [ { "alias": "johndoe", "aliasId": "alias_2DveJ9HKmURNmKrz3EOxWZ", "createdDate": "2021-10-21T04:04:46.309+00:00", "modifiedDate": "2021-10-21T04:04:46.309+00:00" }, { "alias": "john_doe", "aliasId": "alias_6AWYrzkzVOfLPIF2iQRBFe", "createdDate": "2021-10-21T04:04:46.505+00:00", "modifiedDate": "2021-10-21T04:04:46.505+00:00" } ], "createdDate": "2021-10-21T04:03:30.678+00:00", "deviceCount": 1, "devices": [ { "createdDate": "2021-02-26T08:32:36.149+00:00", "deviceId": "device_5Vv4g1iex1ntW5L1bQbcaG", "deviceName": "iPhone", "deviceType": "AKAMAI_AUTHENTICATOR", "modifiedDate": "2021-03-04T17:15:11.719+00:00", "platform": "ios" }, { "createdDate": "2021-02-26T08:33:38.521+00:00", "deviceId": "device_7HKbbp6wDRqHiYJW8d2lpY", "deviceName": "Security Key", "deviceType": "SECURITY_KEY", "modifiedDate": "2021-02-26T08:33:38.521+00:00", "platform": "fido2" } ], "email": "tyamada@example.com", "firstName": "John", "groups": [ { "groupId": "group_5PzsV2iwFgugE51YdbCPd9", "groupName": "admins", "summary": "Group with admin access to acme resources" }, { "groupId": "group_78zsV2iwFgugE51YdbCP45", "groupName": "sales", "summary": "Group for Sales users" } ], "importSource": { "id": "scim_1787", "type": "SCIM" }, "lastName": "Doe", "modifiedDate": "2021-10-21T04:04:45.091+00:00", "userId": "user_2eVKpVVpgzM3fPWsao3sbh", "userStatus": "ACTIVE", "username": "alfulani" }, { "aliases": [ { "alias": "smithj", "aliasId": "alias_6DP9c4ovAm3pCR5sPb9kJS", "createdDate": "2021-10-21T04:07:42.319+00:00", "modifiedDate": "2021-10-21T04:07:42.319+00:00" }, { "alias": "john_smith", "aliasId": "alias_6Hawc7kOU3NTdWlvGfBodv", "createdDate": "2021-10-21T04:07:42.395+00:00", "modifiedDate": "2021-10-21T04:07:42.395+00:00" } ], "createdDate": "2021-10-21T04:06:45.767+00:00", "deviceCount": 0, "devices": [], "email": "jsmith@example.com", "firstName": "John", "groups": [ { "groupId": "group_5PzsV2iwFgugE51YdbCPd9", "groupName": "admins", "summary": "Group with admin access to acme resources" } ], "lastName": "Smith", "modifiedDate": "2021-10-21T04:07:41.255+00:00", "userId": "user_Zh2UcHNP8VhU7M8VlwWEg", "userStatus": "UNENROLLED", "username": "jsmith" } ] }, "schema": { "additionalProperties": false, "description": "Provides response data with a list of user accounts configured in Akamai MFA.", "properties": { "page": { "description": "The currently displayed page.", "minimum": 1, "type": "integer" }, "totalItems": { "description": "The total number of user accounts matching the entered query.", "minimum": 0, "type": "integer" }, "totalPages": { "description": "The number of user accounts displayed on each page.", "minimum": 0, "type": "integer" }, "users": { "description": "A paged list of user accounts configured in Akamai MFA.", "items": { "additionalProperties": false, "description": "Provides response data for a specific user.", "properties": { "aliases": { "description": "The user's alternate names.", "items": { "additionalProperties": false, "description": "Specifies details for a user's alias.", "properties": { "alias": { "description": "Alternate usernames for the user.", "minLength": 1, "type": "string" }, "aliasId": { "description": "A unique identifier for the user's alternate username.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking when the alias was created.", "format": "date-time", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the alias was last modified.", "format": "date-time", "type": "string" } }, "required": [ "aliasId", "alias", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/user-alias.yaml" } }, "minItems": 0, "type": "array" }, "createdDate": { "description": "ISO 8601 timestamp marking when the user account was created.", "format": "date-time", "type": "string" }, "deviceCount": { "description": "The number of authentication devices enrolled by the user in Akamai MFA. The user can enroll and use a set of authentication devices. The supported device types include the following: `PUSH`. Any device that supports sending push notifications, for example, tablets and smartphones. `PHONE_ONLY`. A non-smartphone mobile device that supports only text messages and calls. `SECURITY_KEY`. A FIDO2 WebAuthn security key such as a YubiKey or Akamai MFA phone security key. `TOTP`. A hardware device that generates one-time passcodes. `HARDWARE_TOKEN`. A security device that generates one-time passcodes.", "minimum": 0, "type": "integer" }, "devices": { "description": "Authentication devices the user enrolled in Akamai MFA.", "items": { "additionalProperties": false, "description": "Provides response data for a specific user device.", "properties": { "createdDate": { "description": "ISO 8601 timestamp marking when the device was created.", "format": "date-time", "type": "string" }, "deviceId": { "description": "Uniquely identifies the authentication device enrolled by the user.", "minLength": 1, "type": "string" }, "deviceName": { "description": "A user-friendly name to identify the authentication device.", "minLength": 1, "type": "string" }, "deviceType": { "description": "A user's type of authentication device. Refer to [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts) to learn about device types.", "enum": [ "AKAMAI_AUTHENTICATOR", "BYPASS_CODE", "EMAIL_ADDRESS", "GENERIC_WEBAUTHN", "HARDWARE_TOKEN", "PASSKEY", "PHONE_NUMBER", "PLATFORM_AUTHENTICATOR", "REMEMBER_CLIENT", "SECURITY_KEY", "THIRD_PARTY_AUTHENTICATOR" ], "type": "string" }, "isDeviceEnabled": { "description": "Whether the authentication device is enabled in Akamai MFA. You can disable a user's device that remains inactive or poses a threat to your data. Users can't use a deactivated device to confirm their identity. Disabling a device is reversible, and isn't the same as permanently deleting a device. See [Enable a device](https://techdocs.akamai.com/mfa/reference/post-enable-user-device) and [Disable a device](https://techdocs.akamai.com/mfa/reference/post-disable-user-device) for details on how to manage user devices.", "type": "boolean" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the device was last modified, or when it was last used since then.", "format": "date-time", "type": "string" }, "platform": { "description": "The platform of the authentication device.", "minLength": 1, "type": "string" } }, "required": [ "deviceId", "deviceType", "platform", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/device.yaml" } }, "minItems": 0, "type": "array" }, "email": { "description": "The user's email address.", "minLength": 1, "type": "string" }, "firstName": { "description": "The user's first name.", "minLength": 1, "type": "string" }, "groups": { "description": "Lists the user's group memberships.", "items": { "additionalProperties": false, "properties": { "groupId": { "description": "Unique identifier for the group.", "minLength": 1, "type": "string" }, "groupName": { "description": "Descriptive label for the group.", "minLength": 1, "type": "string" }, "summary": { "description": "Summary of the group. Indicates what the group represents.", "minLength": 0, "type": "string" } }, "required": [ "groupId", "groupName" ], "type": "object", "x-akamai": { "file-path": "schemas/user-group.yaml" } }, "minItems": 0, "type": "array" }, "importSource": { "additionalProperties": false, "description": "The imported user's provisioning source. A `null` value marks manually imported users.", "nullable": true, "properties": { "id": { "description": "A unique identifier for the imported user's provisioning source.", "minLength": 1, "type": "string" }, "type": { "description": "The imported user's provisioning source, either `SCIM` or `EAA`.", "enum": [ "SCIM", "EAA" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/user-source.yaml" } }, "lastName": { "description": "The user's last name.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the user account was last modified.", "format": "date-time", "type": "string" }, "userId": { "description": "A unique identifier for each user account.", "minLength": 1, "type": "string" }, "userStatus": { "description": "The status of the user account, either `ACTIVE`, `UNENROLLED`, `DEVICES_DISABLED`, or `PROVISIONING_DISABLED`. Refer to [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts) to learn more about user account status.", "enum": [ "ACTIVE", "UNENROLLED", "DEVICES_DISABLED", "PROVISIONING_DISABLED" ], "type": "string" }, "username": { "description": "The user's username. The username is unique for the tenant.", "minLength": 1, "type": "string" } }, "required": [ "userId", "username", "userStatus", "deviceCount", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/user-detail.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "users", "totalPages", "totalItems" ], "type": "object", "x-akamai": { "file-path": "schemas/users-get-200.yaml" } } } }, "description": "The response provides a list of users." }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "List users", "tags": [ "Users" ] }, "x-akamai": { "file-path": "paths/users.yaml", "path-info": "/users" } }, "/users/{userId}": { "get": { "description": "Get 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.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/get-user" }, "operationId": "get-user", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "aliases": [ { "alias": "johndoe", "aliasId": "alias_2DveJ9HKmURNmKrz3EOxWZ", "createdDate": "2021-10-21T04:04:46.309+00:00", "modifiedDate": "2021-10-21T04:04:46.309+00:00" }, { "alias": "john_doe", "aliasId": "alias_6AWYrzkzVOfLPIF2iQRBFe", "createdDate": "2021-10-21T04:04:46.505+00:00", "modifiedDate": "2021-10-21T04:04:46.505+00:00" } ], "createdDate": "2021-10-21T04:03:30.678+00:00", "deviceCount": 1, "email": "mrossi@example.com", "firstName": "John", "groups": [ { "groupId": "group_5PzsV2iwFgugE51YdbCPd9", "groupName": "admins", "summary": "Group with admin access to acme resources" }, { "groupId": "group_7AzsV2iwFgugE51YdbCPB9", "groupName": "sales", "summary": "Group for Sales users" } ], "importSource": { "id": "scim_1787", "type": "SCIM" }, "lastName": "Doe", "modifiedDate": "2021-10-21T04:04:45.091+00:00", "userId": "user_2eVKpVVpgzM3fPWsao3sbh", "userStatus": "ACTIVE", "username": "asingh" }, "schema": { "additionalProperties": false, "description": "Provides response data for a specific user.", "properties": { "aliases": { "description": "The user's alternate names.", "items": { "additionalProperties": false, "description": "Specifies details for a user's alias.", "properties": { "alias": { "description": "Alternate usernames for the user.", "minLength": 1, "type": "string" }, "aliasId": { "description": "A unique identifier for the user's alternate username.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking when the alias was created.", "format": "date-time", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the alias was last modified.", "format": "date-time", "type": "string" } }, "required": [ "aliasId", "alias", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/user-alias.yaml" } }, "minItems": 0, "type": "array" }, "createdDate": { "description": "ISO 8601 timestamp marking when the user account was created.", "format": "date-time", "type": "string" }, "deviceCount": { "description": "The number of authentication devices enrolled by the user in Akamai MFA. The user can enroll and use a set of authentication devices. The supported device types include the following: `PUSH`. Any device that supports sending push notifications, for example, tablets and smartphones. `PHONE_ONLY`. A non-smartphone mobile device that supports only text messages and calls. `SECURITY_KEY`. A FIDO2 WebAuthn security key such as a YubiKey or Akamai MFA phone security key. `TOTP`. A hardware device that generates one-time passcodes. `HARDWARE_TOKEN`. A security device that generates one-time passcodes.", "minimum": 0, "type": "integer" }, "devices": { "description": "Authentication devices the user enrolled in Akamai MFA.", "items": { "additionalProperties": false, "description": "Provides response data for a specific user device.", "properties": { "createdDate": { "description": "ISO 8601 timestamp marking when the device was created.", "format": "date-time", "type": "string" }, "deviceId": { "description": "Uniquely identifies the authentication device enrolled by the user.", "minLength": 1, "type": "string" }, "deviceName": { "description": "A user-friendly name to identify the authentication device.", "minLength": 1, "type": "string" }, "deviceType": { "description": "A user's type of authentication device. Refer to [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts) to learn about device types.", "enum": [ "AKAMAI_AUTHENTICATOR", "BYPASS_CODE", "EMAIL_ADDRESS", "GENERIC_WEBAUTHN", "HARDWARE_TOKEN", "PASSKEY", "PHONE_NUMBER", "PLATFORM_AUTHENTICATOR", "REMEMBER_CLIENT", "SECURITY_KEY", "THIRD_PARTY_AUTHENTICATOR" ], "type": "string" }, "isDeviceEnabled": { "description": "Whether the authentication device is enabled in Akamai MFA. You can disable a user's device that remains inactive or poses a threat to your data. Users can't use a deactivated device to confirm their identity. Disabling a device is reversible, and isn't the same as permanently deleting a device. See [Enable a device](https://techdocs.akamai.com/mfa/reference/post-enable-user-device) and [Disable a device](https://techdocs.akamai.com/mfa/reference/post-disable-user-device) for details on how to manage user devices.", "type": "boolean" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the device was last modified, or when it was last used since then.", "format": "date-time", "type": "string" }, "platform": { "description": "The platform of the authentication device.", "minLength": 1, "type": "string" } }, "required": [ "deviceId", "deviceType", "platform", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/device.yaml" } }, "minItems": 0, "type": "array" }, "email": { "description": "The user's email address.", "minLength": 1, "type": "string" }, "firstName": { "description": "The user's first name.", "minLength": 1, "type": "string" }, "groups": { "description": "Lists the user's group memberships.", "items": { "additionalProperties": false, "properties": { "groupId": { "description": "Unique identifier for the group.", "minLength": 1, "type": "string" }, "groupName": { "description": "Descriptive label for the group.", "minLength": 1, "type": "string" }, "summary": { "description": "Summary of the group. Indicates what the group represents.", "minLength": 0, "type": "string" } }, "required": [ "groupId", "groupName" ], "type": "object", "x-akamai": { "file-path": "schemas/user-group.yaml" } }, "minItems": 0, "type": "array" }, "importSource": { "additionalProperties": false, "description": "The imported user's provisioning source. A `null` value marks manually imported users.", "nullable": true, "properties": { "id": { "description": "A unique identifier for the imported user's provisioning source.", "minLength": 1, "type": "string" }, "type": { "description": "The imported user's provisioning source, either `SCIM` or `EAA`.", "enum": [ "SCIM", "EAA" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/user-source.yaml" } }, "lastName": { "description": "The user's last name.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the user account was last modified.", "format": "date-time", "type": "string" }, "userId": { "description": "A unique identifier for each user account.", "minLength": 1, "type": "string" }, "userStatus": { "description": "The status of the user account, either `ACTIVE`, `UNENROLLED`, `DEVICES_DISABLED`, or `PROVISIONING_DISABLED`. Refer to [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts) to learn more about user account status.", "enum": [ "ACTIVE", "UNENROLLED", "DEVICES_DISABLED", "PROVISIONING_DISABLED" ], "type": "string" }, "username": { "description": "The user's username. The username is unique for the tenant.", "minLength": 1, "type": "string" } }, "required": [ "userId", "username", "userStatus", "deviceCount", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/user-detail.yaml" } } } }, "description": "The response provides data for a single user." }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Get a user", "tags": [ "Users" ] }, "put": { "description": "Modify a user's basic information. To add an alias or assign a group to a user, run the [Add an alias to a user](https://techdocs.akamai.com/mfa/reference/post-alias-to-user) and [Assign groups](https://techdocs.akamai.com/mfa/reference/post-assign-groups-to-user) operations.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/put-user" }, "operationId": "put-user", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "email": "asingh@example.com", "firstName": "J", "lastName": "Doe", "username": "adevi@example.com" }, "schema": { "additionalProperties": false, "description": "Update user request JSON.", "properties": { "email": { "description": "The user's email address.", "minLength": 1, "type": "string" }, "firstName": { "description": "The user's first name.", "minLength": 1, "type": "string" }, "lastName": { "description": "The user's last name.", "minLength": 1, "type": "string" }, "username": { "description": "The user's username. The username is unique for the tenant.", "minLength": 1, "type": "string" } }, "required": [ "firstName", "lastName", "email", "username" ], "type": "object", "x-akamai": { "file-path": "schemas/update-user-request.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "aliases": [ { "alias": "johndoe", "aliasId": "alias_2DveJ9HKmURNmKrz3EOxWZ", "createdDate": "2021-10-21T04:04:46.309+00:00", "modifiedDate": "2021-10-21T04:04:46.309+00:00" }, { "alias": "john_doe", "aliasId": "alias_6AWYrzkzVOfLPIF2iQRBFe", "createdDate": "2021-10-21T04:04:46.505+00:00", "modifiedDate": "2021-10-21T04:04:46.505+00:00" } ], "createdDate": "2021-10-21T04:03:30.678+00:00", "deviceCount": 1, "email": "mrossi@example.com", "firstName": "John", "groups": [ { "groupId": "group_5PzsV2iwFgugE51YdbCPd9", "groupName": "admins", "summary": "Group with admin access to acme resources" }, { "groupId": "group_7AzsV2iwFgugE51YdbCPB9", "groupName": "sales", "summary": "Group for Sales users" } ], "importSource": { "id": "scim_1787", "type": "SCIM" }, "lastName": "Doe", "modifiedDate": "2021-10-21T04:04:45.091+00:00", "userId": "user_2eVKpVVpgzM3fPWsao3sbh", "userStatus": "ACTIVE", "username": "asingh" }, "schema": { "additionalProperties": false, "description": "Provides response data for a specific user.", "properties": { "aliases": { "description": "The user's alternate names.", "items": { "additionalProperties": false, "description": "Specifies details for a user's alias.", "properties": { "alias": { "description": "Alternate usernames for the user.", "minLength": 1, "type": "string" }, "aliasId": { "description": "A unique identifier for the user's alternate username.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking when the alias was created.", "format": "date-time", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the alias was last modified.", "format": "date-time", "type": "string" } }, "required": [ "aliasId", "alias", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/user-alias.yaml" } }, "minItems": 0, "type": "array" }, "createdDate": { "description": "ISO 8601 timestamp marking when the user account was created.", "format": "date-time", "type": "string" }, "deviceCount": { "description": "The number of authentication devices enrolled by the user in Akamai MFA. The user can enroll and use a set of authentication devices. The supported device types include the following: `PUSH`. Any device that supports sending push notifications, for example, tablets and smartphones. `PHONE_ONLY`. A non-smartphone mobile device that supports only text messages and calls. `SECURITY_KEY`. A FIDO2 WebAuthn security key such as a YubiKey or Akamai MFA phone security key. `TOTP`. A hardware device that generates one-time passcodes. `HARDWARE_TOKEN`. A security device that generates one-time passcodes.", "minimum": 0, "type": "integer" }, "devices": { "description": "Authentication devices the user enrolled in Akamai MFA.", "items": { "additionalProperties": false, "description": "Provides response data for a specific user device.", "properties": { "createdDate": { "description": "ISO 8601 timestamp marking when the device was created.", "format": "date-time", "type": "string" }, "deviceId": { "description": "Uniquely identifies the authentication device enrolled by the user.", "minLength": 1, "type": "string" }, "deviceName": { "description": "A user-friendly name to identify the authentication device.", "minLength": 1, "type": "string" }, "deviceType": { "description": "A user's type of authentication device. Refer to [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts) to learn about device types.", "enum": [ "AKAMAI_AUTHENTICATOR", "BYPASS_CODE", "EMAIL_ADDRESS", "GENERIC_WEBAUTHN", "HARDWARE_TOKEN", "PASSKEY", "PHONE_NUMBER", "PLATFORM_AUTHENTICATOR", "REMEMBER_CLIENT", "SECURITY_KEY", "THIRD_PARTY_AUTHENTICATOR" ], "type": "string" }, "isDeviceEnabled": { "description": "Whether the authentication device is enabled in Akamai MFA. You can disable a user's device that remains inactive or poses a threat to your data. Users can't use a deactivated device to confirm their identity. Disabling a device is reversible, and isn't the same as permanently deleting a device. See [Enable a device](https://techdocs.akamai.com/mfa/reference/post-enable-user-device) and [Disable a device](https://techdocs.akamai.com/mfa/reference/post-disable-user-device) for details on how to manage user devices.", "type": "boolean" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the device was last modified, or when it was last used since then.", "format": "date-time", "type": "string" }, "platform": { "description": "The platform of the authentication device.", "minLength": 1, "type": "string" } }, "required": [ "deviceId", "deviceType", "platform", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/device.yaml" } }, "minItems": 0, "type": "array" }, "email": { "description": "The user's email address.", "minLength": 1, "type": "string" }, "firstName": { "description": "The user's first name.", "minLength": 1, "type": "string" }, "groups": { "description": "Lists the user's group memberships.", "items": { "additionalProperties": false, "properties": { "groupId": { "description": "Unique identifier for the group.", "minLength": 1, "type": "string" }, "groupName": { "description": "Descriptive label for the group.", "minLength": 1, "type": "string" }, "summary": { "description": "Summary of the group. Indicates what the group represents.", "minLength": 0, "type": "string" } }, "required": [ "groupId", "groupName" ], "type": "object", "x-akamai": { "file-path": "schemas/user-group.yaml" } }, "minItems": 0, "type": "array" }, "importSource": { "additionalProperties": false, "description": "The imported user's provisioning source. A `null` value marks manually imported users.", "nullable": true, "properties": { "id": { "description": "A unique identifier for the imported user's provisioning source.", "minLength": 1, "type": "string" }, "type": { "description": "The imported user's provisioning source, either `SCIM` or `EAA`.", "enum": [ "SCIM", "EAA" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object", "x-akamai": { "file-path": "schemas/user-source.yaml" } }, "lastName": { "description": "The user's last name.", "minLength": 1, "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the user account was last modified.", "format": "date-time", "type": "string" }, "userId": { "description": "A unique identifier for each user account.", "minLength": 1, "type": "string" }, "userStatus": { "description": "The status of the user account, either `ACTIVE`, `UNENROLLED`, `DEVICES_DISABLED`, or `PROVISIONING_DISABLED`. Refer to [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts) to learn more about user account status.", "enum": [ "ACTIVE", "UNENROLLED", "DEVICES_DISABLED", "PROVISIONING_DISABLED" ], "type": "string" }, "username": { "description": "The user's username. The username is unique for the tenant.", "minLength": 1, "type": "string" } }, "required": [ "userId", "username", "userStatus", "deviceCount", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/user-detail.yaml" } } } }, "description": "The response provides data for a single user." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Update a user", "tags": [ "Users" ] }, "delete": { "description": "Permanently delete a specific user account. You can delete any active user account from your Akamai MFA service. For manually added users, deleting means permanently removing the user accounts together with any enrolled authentication device. User accounts that still exist in the external source directory reappear after the next synchronization.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/delete-user" }, "operationId": "delete-user", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "The user was successfully deleted." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Delete a user", "tags": [ "Users" ] }, "parameters": [ { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/user.yaml", "path-info": "/users/{userId}" } }, "/users/{userId}/aliases": { "post": { "description": "Add an alternative username for a user.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/post-alias-to-user" }, "operationId": "post-alias-to-user", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "alias": "john_doe@example.com" }, "schema": { "additionalProperties": false, "description": "Specifies the user's alias.", "properties": { "alias": { "description": "Alternate usernames for the user.", "minLength": 1, "type": "string" } }, "required": [ "alias" ], "type": "object", "x-akamai": { "file-path": "schemas/add-user-alias.yaml" } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "alias": "john_doe@example.com", "aliasId": "alias_63rsiArOttoiRMxtzaG8hN", "createdDate": "2024-09-10T09:11:13.671+00:00", "modifiedDate": "2024-09-10T09:11:13.671+00:00" }, "schema": { "additionalProperties": false, "description": "Specifies details for a user's alias.", "properties": { "alias": { "description": "Alternate usernames for the user.", "minLength": 1, "type": "string" }, "aliasId": { "description": "A unique identifier for the user's alternate username.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking when the alias was created.", "format": "date-time", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the alias was last modified.", "format": "date-time", "type": "string" } }, "required": [ "aliasId", "alias", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/user-alias.yaml" } } } }, "description": "Alias successfully created." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Add an alias to a user", "tags": [ "User aliases" ] }, "parameters": [ { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/aliases.yaml", "path-info": "/users/{userId}/aliases" } }, "/users/{userId}/aliases/{userAliasId}": { "delete": { "description": "Permanently delete a user's alias.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/delete-user-alias" }, "operationId": "delete-user-alias", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "204": { "content": {}, "description": "Alias successfully deleted." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Delete an alias assigned to a user", "tags": [ "User aliases" ] }, "parameters": [ { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } }, { "description": "A unique identifier for the user alias.", "in": "path", "name": "userAliasId", "required": true, "schema": { "example": "alias_63rsi", "type": "string" }, "x-akamai": { "file-path": "parameters/user-alias-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/user-alias.yaml", "path-info": "/users/{userId}/aliases/{userAliasId}" } }, "/users/{userId}/assign-groups": { "post": { "description": "Assign 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 you modify the users' group membership, you can manage their access to different integrations at group level.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/post-assign-groups-to-user" }, "operationId": "post-assign-groups-to-user", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "groupIds": [ "group_5PzsV2iwFgugE51YdbCPd9" ] }, "schema": { "additionalProperties": false, "description": "Specifies groups to assign to a user account.", "properties": { "groupIds": { "description": "A set of groups to assign to a specific user account.", "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "groupIds" ], "type": "object", "x-akamai": { "file-path": "schemas/assign-groups.yaml" } } } }, "required": true }, "responses": { "204": { "content": {}, "description": "The groups were successfully assigned to the user account." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Assign groups", "tags": [ "Groups" ] }, "parameters": [ { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/assign-groups.yaml", "path-info": "/users/{userId}/assign-groups" } }, "/users/{userId}/assign-policies": { "post": { "description": "Assign 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 you modify the users' policy assignation, the users need to meet the requirements of a specific authentication policy before they can access a protected application.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/post-assign-policies-to-user" }, "operationId": "post-assign-policies-to-user", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "policyIds": [ "policy_HTQwbQV77nJx9FaLSAnAo", "policy_Td4WCEhgIGnYV9vsL1FlJ" ] }, "schema": { "additionalProperties": false, "description": "Specifies policies to assign to a user account.", "properties": { "policyIds": { "description": "A set of policies to assign to a specific user account.", "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "policyIds" ], "type": "object", "x-akamai": { "file-path": "schemas/assign-policies.yaml" } } } }, "required": true }, "responses": { "202": { "content": {}, "description": "The policies were successfully assigned to the user account." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Assign policies", "tags": [ "Policies" ] }, "parameters": [ { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/assign-policies.yaml", "path-info": "/users/{userId}/assign-policies" } }, "/users/{userId}/bypass-codes": { "post": { "description": "Generate a new bypass code for a specific user account.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/post-bypass-code" }, "operationId": "post-bypass-code", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expirationDate": "2021-11-21T04:59:00.000+00:00", "remainingUses": 2 }, "schema": { "additionalProperties": false, "description": "Specifies the bypass code's expiry date and its maximum reuse count.", "properties": { "expirationDate": { "description": "ISO 8601 timestamp indicating when the bypass code expires.", "format": "date-time", "type": "string" }, "remainingUses": { "description": "The bypass code reuse count at a given time. The maximum reuse number is `10`.", "maximum": 10, "minimum": 1, "type": "integer" } }, "required": [ "expirationDate", "remainingUses" ], "type": "object", "x-akamai": { "file-path": "schemas/bypass-code-create.yaml" } } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "bypassCode": "etuvbvh45bpxjivw", "bypassCodeId": "code_1ZG8vfR161vJO3Pq1fl2X0", "createdDate": "2021-11-20T10:29:13.976+00:00", "expirationDate": "2021-11-21T04:59:00.000+00:00", "modifiedDate": "2021-11-20T10:29:13.976+00:00", "remainingUses": 2 }, "schema": { "additionalProperties": false, "description": "Provides response data for a specific bypass code.", "properties": { "bypassCode": { "description": "The bypass code value that the user can use to authenticate.", "minLength": 1, "type": "string" }, "bypassCodeId": { "description": "A unique identifier for the bypass code.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking when the bypass code was created.", "format": "date-time", "type": "string" }, "expirationDate": { "description": "ISO 8601 timestamp indicating when the bypass code expires.", "format": "date-time", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the bypass code was last modified, or when it was last used since then.", "format": "date-time", "type": "string" }, "remainingUses": { "description": "The bypass code reuse count at a given time. The maximum reuse number is `10`.", "maximum": 10, "minimum": 1, "type": "integer" } }, "required": [ "bypassCodeId", "bypassCode", "expirationDate", "remainingUses", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/bypass-code-get-200.yaml" } } } }, "description": "The operation provides data for a newly created bypass code.", "headers": { "Location": { "description": "A URL path where you can GET the newly created resource.", "schema": { "example": "/amfa/v1/users/user_2eVKpVVpgzM3fPWsao3sbh/bypass-codes/code_1ZG8vfR161vJO3Pq1fl2X0", "type": "string" }, "x-akamai": { "file-path": "headers/location.yaml" } } } }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Create a bypass code", "tags": [ "Bypass codes" ] }, "get": { "description": "List all the bypass codes generated for a specific user account.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/get-bypass-codes" }, "operationId": "get-bypass-codes", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "bypassCodes": [ { "bypassCode": "r7ek5789d5ntji8b", "bypassCodeId": "code_k97ARdqAbu1LcRNUCZZDk", "createdDate": "2021-06-11T00:16:13.032+00:00", "expirationDate": "2021-06-24T23:59:00.000+00:00", "modifiedDate": "2021-06-11T00:16:13.032+00:00", "remainingUses": 10 }, { "bypassCode": "etuvbvh45bpxjivw", "bypassCodeId": "code_1ZG8vfR161vJO3Pq1fl2X0", "createdDate": "2021-11-20T10:29:13.976+00:00", "expirationDate": "2021-11-21T04:59:00.000+00:00", "modifiedDate": "2021-11-20T10:29:13.976+00:00", "remainingUses": 2 } ] }, "schema": { "additionalProperties": false, "description": "Provides response data with bypass codes generated for a specific user account.", "properties": { "bypassCodes": { "description": "Bypass codes generated for a specific user account.", "items": { "additionalProperties": false, "description": "Provides response data for a specific bypass code.", "properties": { "bypassCode": { "description": "The bypass code value that the user can use to authenticate.", "minLength": 1, "type": "string" }, "bypassCodeId": { "description": "A unique identifier for the bypass code.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking when the bypass code was created.", "format": "date-time", "type": "string" }, "expirationDate": { "description": "ISO 8601 timestamp indicating when the bypass code expires.", "format": "date-time", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the bypass code was last modified, or when it was last used since then.", "format": "date-time", "type": "string" }, "remainingUses": { "description": "The bypass code reuse count at a given time. The maximum reuse number is `10`.", "maximum": 10, "minimum": 1, "type": "integer" } }, "required": [ "bypassCodeId", "bypassCode", "expirationDate", "remainingUses", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/bypass-code-get-200.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "bypassCodes" ], "type": "object", "x-akamai": { "file-path": "schemas/bypass-codes.yaml" } } } }, "description": "The response provides a list of bypass codes." }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "List bypass codes", "tags": [ "Bypass codes" ] }, "parameters": [ { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/bypass-codes.yaml", "path-info": "/users/{userId}/bypass-codes" } }, "/users/{userId}/bypass-codes/{bypassCodeId}": { "get": { "description": "Get a specific bypass code.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/get-bypass-code" }, "operationId": "get-bypass-code", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "bypassCode": "etuvbvh45bpxjivw", "bypassCodeId": "code_1ZG8vfR161vJO3Pq1fl2X0", "createdDate": "2021-11-20T10:29:13.976+00:00", "expirationDate": "2021-11-21T04:59:00.000+00:00", "modifiedDate": "2021-11-20T10:29:13.976+00:00", "remainingUses": 2 }, "schema": { "additionalProperties": false, "description": "Provides response data for a specific bypass code.", "properties": { "bypassCode": { "description": "The bypass code value that the user can use to authenticate.", "minLength": 1, "type": "string" }, "bypassCodeId": { "description": "A unique identifier for the bypass code.", "minLength": 1, "type": "string" }, "createdDate": { "description": "ISO 8601 timestamp marking when the bypass code was created.", "format": "date-time", "type": "string" }, "expirationDate": { "description": "ISO 8601 timestamp indicating when the bypass code expires.", "format": "date-time", "type": "string" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the bypass code was last modified, or when it was last used since then.", "format": "date-time", "type": "string" }, "remainingUses": { "description": "The bypass code reuse count at a given time. The maximum reuse number is `10`.", "maximum": 10, "minimum": 1, "type": "integer" } }, "required": [ "bypassCodeId", "bypassCode", "expirationDate", "remainingUses", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/bypass-code-get-200.yaml" } } } }, "description": "The operation provides data for a specific bypass code." }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Get a bypass code", "tags": [ "Bypass codes" ] }, "parameters": [ { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } }, { "description": "A unique identifier for the bypass code.", "in": "path", "name": "bypassCodeId", "required": true, "schema": { "example": "code_1ZG8v", "type": "string" }, "x-akamai": { "file-path": "parameters/bypass-code-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/bypass-code.yaml", "path-info": "/users/{userId}/bypass-codes/{bypassCodeId}" } }, "/users/{userId}/devices": { "get": { "description": "List all the user's authentication devices.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/get-user-devices" }, "operationId": "get-user-devices", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "devices": [ { "createdDate": "2021-02-26T08:32:36.149+00:00", "deviceId": "device_5Vv4g1iex1ntW5L1bQbcaG", "deviceName": "iPhone", "deviceType": "AKAMAI_AUTHENTICATOR", "modifiedDate": "2021-03-04T17:15:11.719+00:00", "platform": "ios" }, { "createdDate": "2021-02-26T08:33:38.521+00:00", "deviceId": "device_7HKbbp6wDRqHiYJW8d2lpY", "deviceName": "Security Key", "deviceType": "SECURITY_KEY", "modifiedDate": "2021-02-26T08:33:38.521+00:00", "platform": "fido2" } ] }, "schema": { "additionalProperties": false, "description": "Provides response data for all devices enrolled by the user.", "properties": { "devices": { "description": "Authentication devices the user enrolled in Akamai MFA.", "items": { "additionalProperties": false, "description": "Provides response data for a specific user device.", "properties": { "createdDate": { "description": "ISO 8601 timestamp marking when the device was created.", "format": "date-time", "type": "string" }, "deviceId": { "description": "Uniquely identifies the authentication device enrolled by the user.", "minLength": 1, "type": "string" }, "deviceName": { "description": "A user-friendly name to identify the authentication device.", "minLength": 1, "type": "string" }, "deviceType": { "description": "A user's type of authentication device. Refer to [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts) to learn about device types.", "enum": [ "AKAMAI_AUTHENTICATOR", "BYPASS_CODE", "EMAIL_ADDRESS", "GENERIC_WEBAUTHN", "HARDWARE_TOKEN", "PASSKEY", "PHONE_NUMBER", "PLATFORM_AUTHENTICATOR", "REMEMBER_CLIENT", "SECURITY_KEY", "THIRD_PARTY_AUTHENTICATOR" ], "type": "string" }, "isDeviceEnabled": { "description": "Whether the authentication device is enabled in Akamai MFA. You can disable a user's device that remains inactive or poses a threat to your data. Users can't use a deactivated device to confirm their identity. Disabling a device is reversible, and isn't the same as permanently deleting a device. See [Enable a device](https://techdocs.akamai.com/mfa/reference/post-enable-user-device) and [Disable a device](https://techdocs.akamai.com/mfa/reference/post-disable-user-device) for details on how to manage user devices.", "type": "boolean" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the device was last modified, or when it was last used since then.", "format": "date-time", "type": "string" }, "platform": { "description": "The platform of the authentication device.", "minLength": 1, "type": "string" } }, "required": [ "deviceId", "deviceType", "platform", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/device.yaml" } }, "minItems": 0, "type": "array" } }, "required": [ "devices" ], "type": "object", "x-akamai": { "file-path": "schemas/devices.yaml" } } } }, "description": "The response provides a list of the user's devices." }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "List the user's devices", "tags": [ "Devices" ] }, "parameters": [ { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/devices.yaml", "path-info": "/users/{userId}/devices" } }, "/users/{userId}/devices/assign-hardware-token": { "post": { "description": "Assign 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 hardware token from one active user account to another. A hardware token assigned to a user account gets automatically unassigned when the account is deleted, and returns to the pool of available tokens that you can assign to another user.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/post-assign-hardware-token" }, "operationId": "post-assign-hardware-token", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "deviceId": "device_5Vv4g1iex1ntW5L1bQbcaG" }, "schema": { "additionalProperties": false, "description": "Specifies a hardware token to assign to a user account.", "properties": { "deviceId": { "description": "A unique identifier for the hardware token. You can assign only one token to a specific user account.", "minLength": 1, "type": "string" } }, "required": [ "deviceId" ], "type": "object", "x-akamai": { "file-path": "schemas/assign-hardware-token.yaml" } } } }, "required": true }, "responses": { "202": { "content": {}, "description": "The hardware token was successfully assigned to the user account." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Assign a hardware token", "tags": [ "Devices" ] }, "parameters": [ { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/assign-hardware-token.yaml", "path-info": "/users/{userId}/devices/assign-hardware-token" } }, "/users/{userId}/devices/{deviceId}/disable": { "post": { "description": "Deactivate the user's authentication device.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/post-disable-user-device" }, "operationId": "post-disable-user-device", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "createdDate": "2021-02-26T08:32:36.149+00:00", "deviceId": "device_5Vv4g1iex1ntW5L1bQbcaG", "deviceName": "iPhone", "deviceType": "AKAMAI_AUTHENTICATOR", "modifiedDate": "2021-03-04T17:15:11.719+00:00", "platform": "ios" }, "schema": { "additionalProperties": false, "description": "Provides response data for a specific user device.", "properties": { "createdDate": { "description": "ISO 8601 timestamp marking when the device was created.", "format": "date-time", "type": "string" }, "deviceId": { "description": "Uniquely identifies the authentication device enrolled by the user.", "minLength": 1, "type": "string" }, "deviceName": { "description": "A user-friendly name to identify the authentication device.", "minLength": 1, "type": "string" }, "deviceType": { "description": "A user's type of authentication device. Refer to [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts) to learn about device types.", "enum": [ "AKAMAI_AUTHENTICATOR", "BYPASS_CODE", "EMAIL_ADDRESS", "GENERIC_WEBAUTHN", "HARDWARE_TOKEN", "PASSKEY", "PHONE_NUMBER", "PLATFORM_AUTHENTICATOR", "REMEMBER_CLIENT", "SECURITY_KEY", "THIRD_PARTY_AUTHENTICATOR" ], "type": "string" }, "isDeviceEnabled": { "description": "Whether the authentication device is enabled in Akamai MFA. You can disable a user's device that remains inactive or poses a threat to your data. Users can't use a deactivated device to confirm their identity. Disabling a device is reversible, and isn't the same as permanently deleting a device. See [Enable a device](https://techdocs.akamai.com/mfa/reference/post-enable-user-device) and [Disable a device](https://techdocs.akamai.com/mfa/reference/post-disable-user-device) for details on how to manage user devices.", "type": "boolean" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the device was last modified, or when it was last used since then.", "format": "date-time", "type": "string" }, "platform": { "description": "The platform of the authentication device.", "minLength": 1, "type": "string" } }, "required": [ "deviceId", "deviceType", "platform", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/device.yaml" } } } }, "description": "The user's authentication device was successfully disabled." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Disable a device", "tags": [ "Devices" ] }, "parameters": [ { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } }, { "description": "A unique identifier for the authentication device the user enrolled in Akamai MFA. The user can authenticate to protected applications using this device.", "in": "path", "name": "deviceId", "required": true, "schema": { "example": "device_78AF5", "type": "string" }, "x-akamai": { "file-path": "parameters/device-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/disable.yaml", "path-info": "/users/{userId}/devices/{deviceId}/disable" } }, "/users/{userId}/devices/{deviceId}/enable": { "post": { "description": "Activate the user's authentication device.", "externalDocs": { "description": "See documentation for this operation in Akamai's Akamai MFA API", "url": "https://techdocs.akamai.com/mfa/reference/post-enable-user-device" }, "operationId": "post-enable-user-device", "parameters": [ { "description": "Unique identifier for the contract.", "in": "query", "name": "contractId", "required": true, "schema": { "example": "C-0N7RAC71", "type": "string" }, "x-akamai": { "file-path": "parameters/contract-id-required.yaml" } }, { "description": "For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).", "in": "query", "name": "accountSwitchKey", "required": false, "schema": { "example": "1-5C0YLB:1-8BYUX", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "createdDate": "2021-02-26T08:32:36.149+00:00", "deviceId": "device_5Vv4g1iex1ntW5L1bQbcaG", "deviceName": "iPhone", "deviceType": "AKAMAI_AUTHENTICATOR", "modifiedDate": "2021-03-04T17:15:11.719+00:00", "platform": "ios" }, "schema": { "additionalProperties": false, "description": "Provides response data for a specific user device.", "properties": { "createdDate": { "description": "ISO 8601 timestamp marking when the device was created.", "format": "date-time", "type": "string" }, "deviceId": { "description": "Uniquely identifies the authentication device enrolled by the user.", "minLength": 1, "type": "string" }, "deviceName": { "description": "A user-friendly name to identify the authentication device.", "minLength": 1, "type": "string" }, "deviceType": { "description": "A user's type of authentication device. Refer to [API concepts](https://techdocs.akamai.com/mfa/reference/mfa-concepts) to learn about device types.", "enum": [ "AKAMAI_AUTHENTICATOR", "BYPASS_CODE", "EMAIL_ADDRESS", "GENERIC_WEBAUTHN", "HARDWARE_TOKEN", "PASSKEY", "PHONE_NUMBER", "PLATFORM_AUTHENTICATOR", "REMEMBER_CLIENT", "SECURITY_KEY", "THIRD_PARTY_AUTHENTICATOR" ], "type": "string" }, "isDeviceEnabled": { "description": "Whether the authentication device is enabled in Akamai MFA. You can disable a user's device that remains inactive or poses a threat to your data. Users can't use a deactivated device to confirm their identity. Disabling a device is reversible, and isn't the same as permanently deleting a device. See [Enable a device](https://techdocs.akamai.com/mfa/reference/post-enable-user-device) and [Disable a device](https://techdocs.akamai.com/mfa/reference/post-disable-user-device) for details on how to manage user devices.", "type": "boolean" }, "modifiedDate": { "description": "ISO 8601 timestamp marking when the device was last modified, or when it was last used since then.", "format": "date-time", "type": "string" }, "platform": { "description": "The platform of the authentication device.", "minLength": 1, "type": "string" } }, "required": [ "deviceId", "deviceType", "platform", "createdDate" ], "type": "object", "x-akamai": { "file-path": "schemas/device.yaml" } } } }, "description": "The user's authentication device was successfully enabled." }, "400": { "content": { "application/problem+json": { "example": { "detail": "JSON Deserialization failure: 'alias: invalid type: null, expected a string at line 2 column 16'", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Bad Request", "type": "https://problems.luna.akamaiapis.net/zt-mfa/bad-request" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Bad request](https://techdocs.akamai.com/mfa/reference/400).", "x-akamai": { "file-path": "errors/400.yaml" } }, "401": { "content": { "application/problem+json": { "example": { "detail": "The request requires authentication.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Unauthorized", "type": "https://problems.luna.akamaiapis.net/zt-mfa/unauthorized" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Unauthorized](https://techdocs.akamai.com/mfa/reference/401).", "x-akamai": { "file-path": "errors/401.yaml" } }, "403": { "content": { "application/problem+json": { "example": { "detail": "User does not have access.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Forbidden", "type": "https://problems.luna.akamaiapis.net/zt-mfa/forbidden" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Forbidden](https://techdocs.akamai.com/mfa/reference/403).", "x-akamai": { "file-path": "errors/403.yaml" } }, "404": { "content": { "application/problem+json": { "example": { "detail": "Resource 'group' using the following lookup 'group_12345' could not be found.", "instance": "33eabe90-c25a-46c7-b6af-f594d885bcd6", "title": "Resource Not Found", "type": "https://problems.luna.akamaiapis.net/zt-mfa/resource.not.found" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Not found](https://techdocs.akamai.com/mfa/reference/404).", "x-akamai": { "file-path": "errors/404.yaml" } }, "500": { "content": { "application/problem+json": { "example": { "detail": "Error in fetching policy details.", "instance": "84093d15-1fd0-421c-9182-8c873165ef58", "title": "Internal Server Error", "type": "https://problems.luna.akamaiapis.net/zt-mfa/internal-server-error" }, "schema": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "errors": { "description": "For errors with more than one detected problem, this represents each as a nested Problem Details object.", "items": { "additionalProperties": false, "description": "Represents error data in the [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457) Problem Details format.", "properties": { "detail": { "description": "Diagnostic instructions to locate and fix the problem.", "minLength": 1, "type": "string" }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "status": { "description": "The HTTP status code that categorizes this error case.", "maximum": 600, "minimum": 100, "type": "integer" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail" ], "type": "object", "x-akamai": { "file-path": "schemas/problem-nested.yaml" } }, "minItems": 0, "type": "array", "uniqueItems": true }, "instance": { "description": "Unique value generated with each API call.", "minLength": 1, "type": "string" }, "title": { "description": "A summary of each error case.", "minLength": 1, "type": "string" }, "type": { "description": "Identifies each error case.", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ], "type": "object", "x-akamai": { "file-path": "schemas/problem.yaml" } } } }, "description": "[Internal server error](https://techdocs.akamai.com/mfa/reference/500).", "x-akamai": { "file-path": "errors/500.yaml" } } }, "summary": "Enable a device", "tags": [ "Devices" ] }, "parameters": [ { "description": "A unique identifier for the user account.", "in": "path", "name": "userId", "required": true, "schema": { "example": "user_123RF", "type": "string" }, "x-akamai": { "file-path": "parameters/user-id-path.yaml" } }, { "description": "A unique identifier for the authentication device the user enrolled in Akamai MFA. The user can authenticate to protected applications using this device.", "in": "path", "name": "deviceId", "required": true, "schema": { "example": "device_78AF5", "type": "string" }, "x-akamai": { "file-path": "parameters/device-id-path.yaml" } } ], "x-akamai": { "file-path": "paths/enable.yaml", "path-info": "/users/{userId}/devices/{deviceId}/enable" } } }, "servers": [ { "url": "https://{hostname}/amfa/v1" } ], "tags": [], "x-readme": { "samples-languages": [ "curl", "python", "node" ] } }