loading

Enterprise Application Access API v1

Manage data path protection, single sign-on, identity access, application security, and management visibility with EAA.

Learn more:

Overview

The Enterprise Application Access API allows you to integrate data path protection, single sign-on, identity access, application security, and management visibility and control for enterprise applications.

Get started

To configure this API for the first time:

  • Review Get Started with APIs for details on how to set up client tokens to access any Akamai API. These tokens appear as custom hostnames that look like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net.

  • Contact your Akamai representative if you do not have your account’s contractId. This required parameter is used in each API request.

  • To enable this API, choose the API service named Enterprise Application Access, and set the access level to READ-WRITE.

EAA deployment concepts

These concepts describe the building blocks of an EAA deployment:

  • Connector. A virtual machine that provides access to a data center by acting as a reverse proxy.

  • Directory. A server that handles authentication and authorization of users.
    • Authentication. Handles the login of a user.
    • Authorization. Handles application permissions for a user.

  • Identity provider (IDP). Creates, maintains, and manages identity information for users, services, or systems. IDPs allow you to link multiple directories together for a unified single sign-on (SSO) experience.

  • Application. The website or application configured with EAA. This can be internal or external facing and can also include SaaS applications, Remote Desktop, or SSH sessions.

  • Client. A desktop application installed on Windows or Mac computers that enables EAA functionality to end-users. The client is required when enforcing wild card settings.

API concepts

These objects allow you to interact with your EAA configuration using the API:

  • Application: A collection of services used within an enterprise. They span a broad range of categories including productivity, business operations, communication, and development operations. These applications are hosted either within the network perimeter of the enterprise or on the cloud. You can list, create, get, modify, and delete an Application.

    You specify the type of application that you want to create. EAA categorizes applications as Access applications, SaaS applications, or Bookmark applications. You can add an application to EAA with either a predefined application profile or a custom application profile.

    • Application IDP: Specifies the identity provider (IDP) configuration settings for an application. You create this association by POSTing an AppIdp object.

    • Application directory: Specifies the associated directory configuration settings for an application. You create this association by POSTing an AppDirectory object.

    • Application group: Specifies the associated group configuration settings for an application. You create this association by POSTing an AppGroup object.

    • Application categoy: Create and assign a category to an application to logically organize the applications in EAA.

    • Application bundle: Create and deploy groups of applications.

    • Audit log report: Generates application audit log reports for a specified timeframe.

  • Rules: Allows you to create access control rules to block or deny access to a set of applications.

  • IDP: Identity providers (IDP) offer user authentication as a service. They create, maintain, and manage identity information for principals (typically a user) in a cloud. Some IDPs can act as the directory and others can delegate authentication back to the Active Directory (AD) or LDAP. IDPs provide authentication to applications within a federated or distributed network.

    • IDP directory: Specifies the associated directory configuration settings for the identity provider (IDP).
    • IDP block user: Use access control rules to block or unblock users in bulk.

  • Directory: To authorize user access to applications in Enterprise Application Access (EAA), you add directories to EAA and associate them with connectors. Then you add groups with permissions and specify user membership. For new accounts, EAA creates a default Cloud Directory that you can use to add users and groups. You should also assign directories to identity providers (IDP), to provide identity as a service.

  • Group: Groups allow you to apply rewrite rules across distinct applications that are related to one another.

  • Group membership: Group membership allows you to view and manage a user’s access to groups.

  • User: Specifies user accounts for individuals accessing EAA applications. You can add and manage user accounts in EAA or link user accounts to external IDP directories.

  • Agent: You can deploy multiple connectors for redundancy and scaling.

  • Certificate: Certificates provide authentication between the client and server to securely send data using Transport Layer Security (TLS). You can create, upload, retrieve, modify, and delete certificates for various components of EAA.

  • Admin Event Report: Admin event queries and reports provide audit trails that demonstrate compliance. You can run an admin event report to generate logs on EAA login, configuration, and system events that are performed or triggered by an EAA administrator.

Device posture

Device posture allows you to capture end user device details and configure device-based access controls for a broad set of devices or for specific applications. EAA captures and reports signals that contain activity metrics for machines that access your applications. It takes approximately 10 minutes or less for a device value change to report back to EAA.

With the device posture, you can view details or modify access for the following device signal information:

  • Activity
  • Risk assessment
  • Browser activity
  • OS activity
  • System disk encryption
  • Firewall status
  • Anti-malware status
  • Device biometrics
  • Jailbroken devices
  • Screen lock

Resources

This section provides details on the API’s various operations.

API summary

Download the RAML descriptors for this API.

Operation Method Endpoint
Applications  
List applications GET /crux/v1/mgmt-pop/apps{?contractId,offset,limit,expand,expand_sdk}
Create an application POST /crux/v1/mgmt-pop/apps{?contractId}
Get an application GET /crux/v1/mgmt-pop/apps/{applicationId}{?contractId,expand,expand_sdk}
Modify an application PUT /crux/v1/mgmt-pop/apps/{applicationId}{?contractId}
Delete an application DELETE /crux/v1/mgmt-pop/apps/{applicationId}{?contractId}
Create a G2O key POST /crux/v1/mgmt-pop/apps/{applicationId}/g2o{?contractId}
Create an edge key POST /crux/v1/mgmt-pop/apps/{applicationId}/edgekey{?contractId}
List services for an application GET /crux/v1/mgmt-pop/apps/{applicationId}/services{?contractId,expand}
List groups for application GET /crux/v1/mgmt-pop/apps/{applicationId}/groups{?contractId,expand}
Deploy an application POST /crux/v1/mgmt-pop/apps/{applicationId}/deploy{?contractId}
List agents GET /crux/v1/mgmt-pop/apps/{applicationId}/agents{?contractId,offset,limit}
Assign agents POST /crux/v1/mgmt-pop/apps/{applicationId}/agents{?contractId}
Get an agent GET /crux/v1/mgmt-pop/apps/{applicationId}/agents/{agentId}{?contractId}
List urllocations GET /crux/v1/mgmt-pop/apps/{applicationId}/urllocation{?contractId,offset,limit}
Get a urllocation GET /crux/v1/mgmt-pop/apps/{applicationId}/urllocation/{locationId}{?contractId}
Application IDPs  
List application IDPs GET /crux/v1/mgmt-pop/appidp{?contractId,offset,limit,expand}
Create an application IDP POST /crux/v1/mgmt-pop/appidp{?contractId}
Get an application IDP GET /crux/v1/mgmt-pop/appidp/{appIdpId}{?contractId,expand}
Delete an application IDP DELETE /crux/v1/mgmt-pop/appidp/{appIdpId}{?contractId}
Application bundles  
List application bundles GET /crux/v1/mgmt-pop/appbundle{?contractId,offset,limit,expand}
Create an application bundle POST /crux/v1/mgmt-pop/appbundle{?contractId}
Get an application bundle GET /crux/v1/mgmt-pop/appbundle/{appBundleId}{?contractId,expand}
Modify an application bundle PUT /crux/v1/mgmt-pop/appbundle/{appBundleId}{?contractId}
Delete an application bundle DELETE /crux/v1/mgmt-pop/appbundle/{appBundleId}{?contractId}
Deploy an application bundle POST /crux/v1/mgmt-pop/appbundle/{appBundleId}/deploy{?contractId}
Application Categories  
List application categories GET /crux/v1/mgmt-pop/appcategories{?contractId,offset,limit,expand}
Create an application category POST /crux/v1/mgmt-pop/appcategories{?contractId}
Get an application category GET /crux/v1/mgmt-pop/appcategories/{appCategoryId}{?contractId,expand}
Modify an application category PUT /crux/v1/mgmt-pop/appcategories/{appCategoryId}{?contractId}
Delete an application category DELETE /crux/v1/mgmt-pop/appcategories/{appCategoryId}{?contractId}
Application directories  
List application directories GET /crux/v1/mgmt-pop/appdirectories{?contractId,offset,limit,expand}
Create or delete application directories POST /crux/v1/mgmt-pop/appdirectories{?contractId,method}
Get an application directory GET /crux/v1/mgmt-pop/appdirectories/{appDirectoryId}{?contractId,expand}
Application groups  
List application groups GET /crux/v1/mgmt-pop/appgroups{?contractId,offset,limit,expand}
Get an application group GET /crux/v1/mgmt-pop/appgroups/{appGroupId}{?contractId,expand}
Audit logs  
Get an audit logs report GET /crux/v1/mgmt-pop/application-reports/ops/query{?start,end,app,tz,limit}
Device posture  
List device inventory GET /crux/v1/device-posture/inventory/list{?deviceId,os,browser,riskRule,firewall,antiMalware,clientVersion,mobile,screenlock,biometric,jailbroken,diskEncryption,etpThreatDetected,cbHealthy,cbPolicy,crowdstrikeHealthy,etpClientStatus,certProfile,antiMalwareProfile,search,offset,limit,sortBy,sortOrder,contractId}
List device activity GET /crux/v1/device-posture/inventory/summary/device-roll-ups{?contractId}
List device risk assessment GET /crux/v1/device-posture/inventory/summary/risk-assessment{?contractId}
List browser activity GET /crux/v1/device-posture/inventory/summary/browsers{?contractId}
List operating system activity GET /crux/v1/device-posture/inventory/summary/os{?contractId}
List system disk encryption GET /crux/v1/device-posture/inventory/summary/system-disk-encryption{?contractId}
List firewall status GET /crux/v1/device-posture/inventory/summary/firewall-status{?contractId}
List anti-malware status GET /crux/v1/device-posture/inventory/summary/anti-malware-status{?contractId}
List devices with biometrics GET /crux/v1/device-posture/inventory/summary/device-biometric{?contractId}
List jailbroken devices GET /crux/v1/device-posture/inventory/summary/device-jailbroken{?contractId}
List device screen lock GET /crux/v1/device-posture/inventory/summary/device-screen-lock{?contractId}
Clear device PUT /crux/v1/device-posture/inventory/device/{deviceId}/op/clear{?contractId}
List device history GET /crux/v1/device-posture/inventory/device-history/{deviceId}{?contractId}
List available operating systems GET /crux/v1/device-posture/risk-assessment/os-names{?contractId}
List available operating system versions GET /crux/v1/device-posture/risk-assessment/available-os-ver{?contractId}
List available browser versions GET /crux/v1/device-posture/risk-assessment/available-browsers{?contractId}
List available client versions GET /crux/v1/device-posture/risk-assessment/available-client-ver{?contractId}
List chosen versions GET /crux/v1/device-posture/risk-assessment/chosen-versions{?contractId}
Modify chosen versions PUT /crux/v1/device-posture/risk-assessment/chosen-versions{?contractId}
Test chosen versions POST /crux/v1/device-posture/risk-assessment/chosen-versions/test{?contractId}
List signal names GET /crux/v1/device-posture/risk-assessment/signal-names{?contractId}
List client versions GET /crux/v1/device-posture/risk-assessment/versions/client_version{?contractId}
List risk tiers GET /crux/v1/device-posture/risk-assessment/tiers{?contractId}
Get a risk tier GET /crux/v1/device-posture/risk-assessment/tiers/{ruleId}{?contractId}
Modify risk tier PUT /crux/v1/device-posture/risk-assessment/tiers/{ruleId}{?contractId}
List risk tags GET /crux/v1/device-posture/risk-assessment/tags{?contractId}
Create risk tag POST /crux/v1/device-posture/risk-assessment/tags{?contractId}
Get a risk tag GET /crux/v1/device-posture/risk-assessment/tags/{ruleId}{?contractId}
Modify a risk tag PUT /crux/v1/device-posture/risk-assessment/tags/{ruleId}{?contractId}
Delete a tag DELETE /crux/v1/device-posture/risk-assessment/tags/{ruleId}{?contractId}
Test risk rule PUT /crux/v1/device-posture/risk-assessment/test/{ruleId}{?contractId}
Get Carbon Black integration GET /crux/v1/device-posture/risk-assessment/partner/carbon-black{?contractId}
Modify Carbon Black integration PUT /crux/v1/device-posture/risk-assessment/partner/carbon-black{?contractId}
Test Carbon Black integration PUT /crux/v1/device-posture/risk-assessment/partner/carbon-black/test{?contractId}
Get CrowdStrike integration GET /crux/v1/device-posture/risk-assessment/partner/crowdstrike{?contractId}
Modify CrowdStrike integration PUT /crux/v1/device-posture/risk-assessment/partner/crowdstrike{?contractId}
Test CrowdStrike integration PUT /crux/v1/device-posture/risk-assessment/partner/crowdstrike/test{?contractId}
Get certificate profiles GET /crux/v1/device-posture/risk-assessment/certificate-profiles{?contractId}
Create certificate profile POST /crux/v1/device-posture/risk-assessment/certificate-profiles{?contractId}
Get certificate profile GET /crux/v1/device-posture/risk-assessment/certificate-profiles/{certificateProfileId}{?contractId}
Update certificate profile PUT /crux/v1/device-posture/risk-assessment/certificate-profiles/{certificateProfileId}{?contractId}
Delete certificate profile DELETE /crux/v1/device-posture/risk-assessment/certificate-profiles/{certificateProfileId}{?contractId}
Get CA and OCSP information GET /crux/v1/device-posture/risk-assessment/ca-ocsp{?contractId}
Get CA information GET /crux/v1/device-posture/risk-assessment/certificate-usage/ca{?contractId}
Get OCSP information GET /crux/v1/device-posture/risk-assessment/certificate-usage/ocsp{?contractId}
List anti-malware profiles GET /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles{?contractId}
Create an anti-malware profile POST /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles{?contractId}
Get an anti-malware profile GET /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/{antiMalwareProfileId}{?contractId}
Update an anti-malware profile PUT /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/{antiMalwareProfileId}{?contractId}
Delete an anti-malware profile DELETE /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/{antiMalwareProfileId}{?contractId}
IDP  
List IDPs GET /crux/v1/mgmt-pop/idp{?contractId,offset,limit,expand}
Create an IDP POST /crux/v1/mgmt-pop/idp{?contractId}
Get an IDP GET /crux/v1/mgmt-pop/idp/{idp_id}{?contractId}
Modify an IDP PUT /crux/v1/mgmt-pop/idp/{idp_id}{?contractId}
Delete an IDP DELETE /crux/v1/mgmt-pop/idp/{idp_id}{?contractId}
Get an IDP directory membership GET /crux/v1/mgmt-pop/idp/{idp_id}/directories_membership{?contractId}
Get an IDP status GET /crux/v1/mgmt-pop/idp/{idp_id}/status{?contractId}
Upload metadata of an IDP POST /crux/v1/mgmt-pop/idp/{idp_id}/metadata{?contractId}
Enable ghost to origin (G2O) for an IDP POST /crux/v1/mgmt-pop/idp/{idp_id}/g2o{?contractId}
IDP directory  
List IDP directories GET /crux/v1/mgmt-pop/idpdirectory{?contractId,offset,limit}
Create an IDP directory POST /crux/v1/mgmt-pop/idpdirectory{?contractId}
Get an IDP directory GET /crux/v1/mgmt-pop/idpdirectory/{idpdirectory_id}{?contractId}
Modify an IDP directory PUT /crux/v1/mgmt-pop/idpdirectory/{idpdirectory_id}{?contractId}
Delete an IDP directory DELETE /crux/v1/mgmt-pop/idpdirectory/{idpdirectory_id}{?contractId}
IDP block user  
Block a user POST /crux/v1/mgmt-pop/idpblockuser/idp/{idp_id}/block{?contractId}
Unblock a user POST /crux/v1/mgmt-pop/idpblockuser/idp/{idp_id}/unblock{?contractId}
Admin events reports  
Get admin events reports GET /crux/v1/mgmt-pop/api/v1/adminevents-reports/ops/reports{?contractId,sts,ets,event_type,res_type}
Certificates  
List certificates GET /crux/v1/mgmt-pop/certificates{?contractId,offset,limit}
Create a certificate POST /crux/v1/mgmt-pop/certificates{?contractId}
Get a certificate GET /crux/v1/mgmt-pop/certificates/{id}{?contractId}
Modify a certificate PUT /crux/v1/mgmt-pop/certificates/{id}{?contractId}
Delete a certificate DELETE /crux/v1/mgmt-pop/certificates/{id}{?contractId}
Upload a certificate POST /crux/v1/mgmt-pop/certificates/{id}/upload{?contractId}
Get CA attributes GET /crux/v1/mgmt-pop/certificates/ca_attributes{?contractId}
Agents  
List connectors GET /crux/v1/mgmt-pop/agents{?contractId,offset,limit}
Create a connector POST /crux/v1/mgmt-pop/agents{?contractId}
Get a connector GET /crux/v1/mgmt-pop/agents/{id}{?contractId}
Modify a connector PUT /crux/v1/mgmt-pop/agents/{id}{?contractId}
Delete a connector DELETE /crux/v1/mgmt-pop/agents/{id}{?contractId}
Approve a connector POST /crux/v1/mgmt-pop/agents/{id}/approve{?contractId}
Directories  
List directories GET /crux/v1/mgmt-pop/directories{?contractId,offset,limit,expand}
Create a directory POST /crux/v1/mgmt-pop/directories{?contractId}
Get a directory GET /crux/v1/mgmt-pop/directories/{directory_id}{?contractId}
Modify a directory PUT /crux/v1/mgmt-pop/directories/{directory_id}{?contractId}
Delete a directory DELETE /crux/v1/mgmt-pop/directories/{directory_id}{?contractId}
List directory applications GET /crux/v1/mgmt-pop/directories/{directory_id}/apps{?contractId}
List directory groups GET /crux/v1/mgmt-pop/directories/{directory_id}/groups{?contractId}
Get group details GET /crux/v1/mgmt-pop/directories/{directory_id}/groups/{group_id}{?contractId}
List directory group users GET /crux/v1/mgmt-pop/directories/{directory_id}/groups/{group_id}/users{?contractId}
List directory users GET /crux/v1/mgmt-pop/directories/{directory_id}/users{?contractId}
Invite an user POST /crux/v1/mgmt-pop/directories/{directory_id}/users{?contractId}
User autocomplete GET /crux/v1/mgmt-pop/directories/{directory_id}/users/autocomplete{?q,contractId}
Get user details GET /crux/v1/mgmt-pop/directories/{directory_id}/users/byname/{user_id}{?contractId}
Bulk create user POST /crux/v1/mgmt-pop/directories/createusers{?contractId}
User upload status GET /crux/v1/mgmt-pop/directories/createusers/status/{cmd_id}{?contractId}
Bulk delete user POST /crux/v1/mgmt-pop/directories/deleteusers{?contractId}
Re-invite user POST /crux/v1/mgmt-pop/directories/reinviteusers{?contractId}
Verify re-invite status GET /crux/v1/mgmt-pop/directories/reinviteusers/status/{cmd_id}{?contractId}
Verify directory POST /crux/v1/mgmt-pop/directories/verify{?contractId}
Check verify status GET /crux/v1/mgmt-pop/directories/verify/{cmd_id}{?contractId}
Search directory POST /crux/v1/mgmt-pop/directories/search{?contractId}
Sync directory POST /crux/v1/mgmt-pop/directories/sync{?contractId}
Group membership  
List group memberships GET /crux/v1/mgmt-pop/groupmembership{?contractId,offset,limit,expand}
Create a group membership POST /crux/v1/mgmt-pop/groupmembership{?contractId}
Get a group membership GET /crux/v1/mgmt-pop/groupmembership/{groupmembership_id}{?contractId}
Delete a group membership DELETE /crux/v1/mgmt-pop/groupmembership/{groupmembership_id}{?contractId}
Groups  
List Groups GET /crux/v1/mgmt-pop/groups{?contractId,offset,limit}
Create a group POST /crux/v1/mgmt-pop/groups{?contractId}
Get a group GET /crux/v1/mgmt-pop/groups/{group_id}{?contractId}
Modify a group PUT /crux/v1/mgmt-pop/groups/{group_id}{?contractId}
Delete a group DELETE /crux/v1/mgmt-pop/groups/{group_id}{?contractId}
List group users GET /crux/v1/mgmt-pop/groups/{group_id}/users{?contractId,offset,limit}
Sync group POST /crux/v1/mgmt-pop/groups/{group_id}/sync{?contractId}
Reset  
Reset OTP POST /crux/v1/mgmt-pop/tenant/mfa/reset{?contractId}
Rules  
List rules GET /crux/v1/mgmt-pop/rules{?contractId,offset,limit}
Create a rule POST /crux/v1/mgmt-pop/rules{?contractId}
Get a rule GET /crux/v1/mgmt-pop/rules/{id}
Modify a rule PUT /crux/v1/mgmt-pop/rules/{id}
Delete a rule DELETE /crux/v1/mgmt-pop/rules/{id}
Users  
List users GET /crux/v1/mgmt-pop/users{?contractId,offset,limit,expand}
Create a user POST /crux/v1/mgmt-pop/users{?contractId}
Get a user GET /crux/v1/mgmt-pop/users/{user_id}{?contractId}
Modify a user PUT /crux/v1/mgmt-pop/users/{user_id}{?contractId}
Delete a user DELETE /crux/v1/mgmt-pop/users/{user_id}{?contractId}

List applications

Lists EAA applications that you have access to.

GET /crux/v1/mgmt-pop/apps{?contractId,offset,limit,expand,expand_sdk}

Sample: /crux/v1/mgmt-pop/apps?contractId=F-EMGSGV&offset=10&limit=30&expand=true&expand_sdk=true

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.
expand_sdk Boolean true When set to true, the application members include services and directories.
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: Application

Download schema: applications.json

Response body:

{
    "meta": {
        "previous": "?limit=2&expand=true&offset=8",
        "total_count": 178,
        "offset": 10,
        "limit": 2,
        "next": "?limit=2&expand=true&offset=10"
    },
    "objects": [
        {
            "auth_type": 1,
            "saml_settings": [
                {
                    "sp": {
                        "dst_url": "",
                        "encr_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                        "default_relay_state": "",
                        "encr_algo": "aes256-cbc",
                        "req_verify": false,
                        "slo_req_verify": false,
                        "slo_bind": "redirect",
                        "entity_id": "https://host.net/saml/sp/response",
                        "resp_encr": false,
                        "req_bind": "redirect",
                        "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                        "logout_bind": "post",
                        "slo_url": "",
                        "force_auth": true,
                        "acs_url": "https://host.net/saml/sp/response",
                        "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
                    },
                    "idp": {
                        "self_signed": true,
                        "ecp_resp_signature": false,
                        "slo_url": "https://host.net/saml/idp/slo",
                        "entity_id": "https://host.net/saml/idp/sso",
                        "resp_bind": "post",
                        "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----\n",
                        "sign_algo": "SHA1",
                        "ecp_enable": false,
                        "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
                    },
                    "attrmap": [
                        {
                            "src": "user.firstName",
                            "fmt": "unspecified",
                            "name": "FirstName",
                            "fname": ""
                        },
                        {
                            "src": "user.email",
                            "fmt": "basic",
                            "name": "Email",
                            "fname": ""
                        },
                        {
                            "src": "user.lastName",
                            "fmt": "basic",
                            "name": "LastName",
                            "fname": ""
                        }
                    ],
                    "subject": {
                        "attr_source": "user.email",
                        "src": "user.userPrincipleName",
                        "fmt": "unspecified"
                    }
                }
            ],
            "domain": 1,
            "domain_suffix": "host.akamai-access.com",
            "app_status": 2,
            "popName": "us-pop-1",
            "pop": "LpeAuKXkEeOg_Q7rYYFrWw",
            "servers": [
                {
                    "origin_host": "10.20.30.100",
                    "orig_tls": true,
                    "origin_port": 22,
                    "origin_protocol": "ssh"
                }
            ],
            "services": [
                {
                    "name": "Acceleration",
                    "uuid_url": "YqQlGzjYRzuSX04"
                },
                {
                    "name": "Access Control",
                    "uuid_url": "RzuSX04c8CECtw15"
                }
            ],
            "agents": [
                {
                    "compatible": true,
                    "name": "Email-App-Connector",
                    "uuid_url": "aldTFght_SfoolsooD26Q"
                },
                {
                    "compatible": true,
                    "name": "App2-Connector",
                    "uuid_url": "askljgoSxmQnkfJ1fozTA"
                }
            ],
            "origin_host": null,
            "app_type": 2,
            "client_app_mode": 1,
            "app_deployed": true,
            "saml": true,
            "auth_agent": null,
            "sites": [
                "skljgoSxoolsooD26Q-qQlGzjYRzuS"
            ],
            "rdp_version": "V1",
            "auth_enabled": "true",
            "uuid_url": "ZgpmtAS0ORa2b0jF",
            "app_logo": "https://host.com/customer-logo/app_icon_<uuid_url>",
            "wsfed_settings": [],
            "advanced_settings": {
                "mfa": "inherit",
                "rdp_initial_program": null,
                "hidden_app": "false",
                "force_mfa": "off",
                "login_timeout": "5",
                "remote_spark_audio": "true",
                "sticky_agent": "false",
                "https_sslv3": "false",
                "authenticated_server_conn_limit": "50",
                "idle_conn_step": "10",
                "idle_close_time_seconds": "1200",
                "logout_url": null,
                "keyed_keepalive_enable": "false",
                "idle_conn_floor": "50",
                "cors_origin_list": "unbounded",
                "health_check_http_host_header": "",
                "session_sticky_cookie_maxage": "0",
                "ssh_audit_enabled": "false",
                "app_auth_domain": null,
                "edge_authentication_enabled": "false",
                "sso": "true",
                "preauth_enforce_url": "",
                "remote_spark_mapClipboard": "on",
                "keepalive_enable": "true",
                "health_check_interval": "30000",
                "idle_conn_ceil": "75",
                "proxy_buffer_size_kb": null,
                "forward_ticket_granting_ticket": "false",
                "websocket_enabled": "false",
                "internal_host_port": "0",
                "authenticated_server_request_limit": "100",
                "g2o_nonce": null,
                "server_request_burst": "100",
                "keepalive_connection_pool": "50",
                "keytab": "",
                "saas_enabled": "false",
                "health_check_http_url": "/",
                "cors_max_age": "86400",
                "inject_ajax_javascript": "off",
                "spdy_enabled": "true",
                "health_check_fall": "3",
                "anonymous_server_conn_limit": "50",
                "client_cert_auth": "false",
                "remote_spark_mapPrinter": "true",
                "domain_exception_list": "",
                "idp_idle_expiry": null,
                "kerberos_negotiate_once": "off",
                "proxy_disable_clipboard": "false",
                "external_cookie_domain": null,
                "app_server_read_timeout": "60",
                "rdp_remote_apps": [],
                "load_balancing_metric": "round-robin",
                "keepalive_timeout": "3",
                "app_location": null,
                "health_check_http_version": "1.1",
                "offload_onpremise_traffic": "false",
                "session_sticky": "false",
                "sentry_redirect_401": "off",
                "remote_spark_disk": "LOCALSHARE",
                "refresh_sticky_cookie": "on",
                "ignore_cname_resolution": "false",
                "user_name": null,
                "http_only_cookie": "true",
                "login_url": null,
                "anonymous_server_request_limit": "100",
                "session_sticky_server_cookie": null,
                "request_body_rewrite": "false",
                "sla_object_url": "____spx/iontestpage",
                "custom_headers": [],
                "pass_phrase": null,
                "edge_cookie_key": "",
                "g2o_key": null,
                "request_parameters": null,
                "wildcard_internal_hostname": "false",
                "logging_enabled": "true",
                "server_cert_validate": "true",
                "rate_limit": "on",
                "rdp_tls1": "false",
                "health_check_timeout": "50000",
                "health_check_rise": "2",
                "g2o_enabled": "false",
                "internal_hostname": "",
                "app_auth": "none",
                "cors_support_credential": "on",
                "cors_header_list": "unbounded",
                "acceleration": "false",
                "remote_spark_mapDisk": "true",
                "hsts_age": "15552000",
                "remote_spark_printer": "LOCALPRINTER",
                "allow_cors": "false",
                "rdp_legacy_mode": "false",
                "cors_method_list": "unbounded",
                "private_key": null,
                "app_cookie_domain": null,
                "service_principle_name": null,
                "app_client_cert_auth": "false",
                "cookie_domain": "",
                "remote_spark_recording": "false",
                "idp_max_expiry": null,
                "wapp_auth": "form",
                "health_check_type": "0",
                "client_cert_user_param": ""
            },
            "app_category": {
                "name": "Communications",
                "uuid_url": "CNasdlkfjlkasdhftZjKIFA"
            },
            "description": "This is the Email Server",
            "app_profile": 1,
            "resource_status": {
                "host_reachable": false,
                "directories_status": 2,
                "origin_host_status": 4,
                "cname_dns_status": 1,
                "data_agent_status": 1,
                "cert_status": 1,
                "host_dns_status": 4,
                "internal_host_status": 1,
                "dialin_server_status": 4,
                "pop_status": 2
            },
            "host": "<uuid_url>.host.akamai-access.com",
            "data_agent": null,
            "orig_tls": "true",
            "origin_port": 443,
            "bookmark_url": "",
            "app_operational": 3,
            "resource": "apps",
            "name": "Primary Email Application",
            "oidc_settings": {},
            "directories": [
                {
                    "user_count": 29584,
                    "type": 1,
                    "name": "Company-Primary-AD",
                    "uuid_url": "_tvruiywwiyipwgvs8rw"
                }
            ],
            "modified_at": "2019-03-28T20:10:22.418270",
            "idp": {
                "idp_id": "aMEgMEgeToipiytpeP1u5kLg",
                "client_cert_auth": "false",
                "client_cert_user_param": "",
                "name": "Pri-SAML-IDP",
                "type": 2
            },
            "cert": null,
            "cname": "<uuid_url>.host.akamai-access.com",
            "status": 1,
            "wsfed": false,
            "oidc": false,
            "created_at": "2017-10-09T21:21:27.548211",
            "resource_uri": {
                "directories": "/api/v1/apps/uuid_url/directories/",
                "sites": "/api/v1/apps/<uuid_url>/sites",
                "pop": "/api/v1/pops/<pop>",
                "href": "/api/v1/apps/<uuid_url>",
                "groups": "/api/v1/apps/<uuid_url>/groups/",
                "services": "/api/v1/apps/<uuid_url>/services/"
            }
        },
        {
            "auth_type": 1,
            "saml_settings": [
                {
                    "sp": {
                        "dst_url": "",
                        "encr_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                        "default_relay_state": "",
                        "encr_algo": "aes256-cbc",
                        "req_verify": false,
                        "slo_req_verify": false,
                        "slo_bind": "redirect",
                        "entity_id": "https://host.net/saml/sp/response",
                        "resp_encr": false,
                        "req_bind": "redirect",
                        "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                        "logout_bind": "post",
                        "slo_url": "",
                        "force_auth": true,
                        "acs_url": "https://host.net/saml/sp/response",
                        "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
                    },
                    "idp": {
                        "self_signed": true,
                        "ecp_resp_signature": false,
                        "slo_url": "https://host.net/saml/idp/slo",
                        "entity_id": "https://host.net/saml/idp/sso",
                        "resp_bind": "post",
                        "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----\n",
                        "sign_algo": "SHA1",
                        "ecp_enable": false,
                        "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
                    },
                    "attrmap": [
                        {
                            "src": "user.firstName",
                            "fmt": "unspecified",
                            "name": "FirstName",
                            "fname": ""
                        },
                        {
                            "src": "user.email",
                            "fmt": "basic",
                            "name": "Email",
                            "fname": ""
                        },
                        {
                            "src": "user.lastName",
                            "fmt": "basic",
                            "name": "LastName",
                            "fname": ""
                        }
                    ],
                    "subject": {
                        "attr_source": "user.email",
                        "src": "user.userPrincipleName",
                        "fmt": "unspecified"
                    }
                }
            ],
            "domain": 1,
            "domain_suffix": "host.akamai-access.com",
            "app_status": 2,
            "popName": "us-pop-1",
            "pop": "LpeAuKXkEeOg_Q7rYYFrWw",
            "servers": [
                {
                    "origin_host": "10.20.30.100",
                    "orig_tls": true,
                    "origin_port": 22,
                    "origin_protocol": "ssh"
                }
            ],
            "services": [
                {
                    "name": "Acceleration",
                    "uuid_url": "YqQlGzjYRzuSX04"
                },
                {
                    "name": "Access Control",
                    "uuid_url": "RzuSX04c8CECtw15"
                }
            ],
            "agents": [
                {
                    "compatible": true,
                    "name": "Email-App-Connector",
                    "uuid_url": "aldTFght_SfoolsooD26Q"
                },
                {
                    "compatible": true,
                    "name": "App2-Connector",
                    "uuid_url": "askljgoSxmQnkfJ1fozTA"
                }
            ],
            "origin_host": null,
            "app_type": 2,
            "client_app_mode": 1,
            "app_deployed": true,
            "saml": true,
            "auth_agent": null,
            "sites": [
                "skljgoSxoolsooD26Q-qQlGzjYRzuS"
            ],
            "rdp_version": "V1",
            "auth_enabled": "true",
            "uuid_url": "ZgpmtAS0ORa2b0jF",
            "app_logo": "https://host.com/customer-logo/app_icon_<uuid_url>",
            "wsfed_settings": [],
            "advanced_settings": {
                "mfa": "inherit",
                "rdp_initial_program": null,
                "hidden_app": "false",
                "force_mfa": "off",
                "login_timeout": "5",
                "remote_spark_audio": "true",
                "sticky_agent": "false",
                "https_sslv3": "false",
                "authenticated_server_conn_limit": "50",
                "idle_conn_step": "10",
                "idle_close_time_seconds": "1200",
                "logout_url": null,
                "keyed_keepalive_enable": "false",
                "idle_conn_floor": "50",
                "cors_origin_list": "unbounded",
                "health_check_http_host_header": "",
                "session_sticky_cookie_maxage": "0",
                "ssh_audit_enabled": "false",
                "app_auth_domain": null,
                "edge_authentication_enabled": "false",
                "sso": "true",
                "preauth_enforce_url": "",
                "remote_spark_mapClipboard": "on",
                "keepalive_enable": "true",
                "health_check_interval": "30000",
                "idle_conn_ceil": "75",
                "proxy_buffer_size_kb": null,
                "forward_ticket_granting_ticket": "false",
                "websocket_enabled": "false",
                "internal_host_port": "0",
                "authenticated_server_request_limit": "100",
                "g2o_nonce": null,
                "server_request_burst": "100",
                "keepalive_connection_pool": "50",
                "keytab": "",
                "saas_enabled": "false",
                "health_check_http_url": "/",
                "cors_max_age": "86400",
                "inject_ajax_javascript": "off",
                "spdy_enabled": "true",
                "health_check_fall": "3",
                "anonymous_server_conn_limit": "50",
                "client_cert_auth": "false",
                "remote_spark_mapPrinter": "true",
                "domain_exception_list": "",
                "idp_idle_expiry": null,
                "kerberos_negotiate_once": "off",
                "proxy_disable_clipboard": "false",
                "external_cookie_domain": null,
                "app_server_read_timeout": "60",
                "rdp_remote_apps": [],
                "load_balancing_metric": "round-robin",
                "keepalive_timeout": "3",
                "app_location": null,
                "health_check_http_version": "1.1",
                "offload_onpremise_traffic": "false",
                "session_sticky": "false",
                "sentry_redirect_401": "off",
                "remote_spark_disk": "LOCALSHARE",
                "refresh_sticky_cookie": "on",
                "ignore_cname_resolution": "false",
                "user_name": null,
                "http_only_cookie": "true",
                "login_url": null,
                "anonymous_server_request_limit": "100",
                "session_sticky_server_cookie": null,
                "request_body_rewrite": "false",
                "sla_object_url": "____spx/iontestpage",
                "custom_headers": [],
                "pass_phrase": null,
                "edge_cookie_key": "",
                "g2o_key": null,
                "request_parameters": null,
                "wildcard_internal_hostname": "false",
                "logging_enabled": "true",
                "server_cert_validate": "true",
                "rate_limit": "on",
                "rdp_tls1": "false",
                "health_check_timeout": "50000",
                "health_check_rise": "2",
                "g2o_enabled": "false",
                "internal_hostname": "",
                "app_auth": "none",
                "cors_support_credential": "on",
                "cors_header_list": "unbounded",
                "acceleration": "false",
                "remote_spark_mapDisk": "true",
                "hsts_age": "15552000",
                "remote_spark_printer": "LOCALPRINTER",
                "allow_cors": "false",
                "rdp_legacy_mode": "false",
                "cors_method_list": "unbounded",
                "private_key": null,
                "app_cookie_domain": null,
                "service_principle_name": null,
                "app_client_cert_auth": "false",
                "cookie_domain": "",
                "remote_spark_recording": "false",
                "idp_max_expiry": null,
                "wapp_auth": "form",
                "health_check_type": "0",
                "client_cert_user_param": ""
            },
            "app_category": {
                "name": "Communications",
                "uuid_url": "CNasdlkfjlkasdhftZjKIFA"
            },
            "description": "This is the Email Server",
            "app_profile": 1,
            "resource_status": {
                "host_reachable": false,
                "directories_status": 2,
                "origin_host_status": 4,
                "cname_dns_status": 1,
                "data_agent_status": 1,
                "cert_status": 1,
                "host_dns_status": 4,
                "internal_host_status": 1,
                "dialin_server_status": 4,
                "pop_status": 2
            },
            "host": "<uuid_url>.host.akamai-access.com",
            "data_agent": null,
            "orig_tls": "true",
            "origin_port": 443,
            "bookmark_url": "",
            "app_operational": 3,
            "resource": "apps",
            "name": "Primary Email Application",
            "oidc_settings": {},
            "directories": [
                {
                    "user_count": 29584,
                    "type": 1,
                    "name": "Company-Primary-AD",
                    "uuid_url": "_tvruiywwiyipwgvs8rw"
                }
            ],
            "modified_at": "2019-03-28T20:10:22.418270",
            "idp": {
                "idp_id": "aMEgMEgeToipiytpeP1u5kLg",
                "client_cert_auth": "false",
                "client_cert_user_param": "",
                "name": "Pri-SAML-IDP",
                "type": 2
            },
            "cert": null,
            "cname": "<uuid_url>.host.akamai-access.com",
            "status": 1,
            "wsfed": false,
            "oidc": false,
            "created_at": "2017-10-09T21:21:27.548211",
            "resource_uri": {
                "directories": "/api/v1/apps/uuid_url/directories/",
                "sites": "/api/v1/apps/<uuid_url>/sites",
                "pop": "/api/v1/pops/<pop>",
                "href": "/api/v1/apps/<uuid_url>",
                "groups": "/api/v1/apps/<uuid_url>/groups/",
                "services": "/api/v1/apps/<uuid_url>/services/"
            }
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. For pagination, set offset the number of members to skip in the object list.

  3. For a pagination, set limit to specify the maximum number of members to return in the response.

  4. Optionally, set expand to true to include additional members in the response.

  5. Optionally, set expand_sdk to true to include services and directories in the response. query parameter.

  6. Make a GET request to /crux/v1/mgmt-pop/apps{?contractId,offset,limit,expand,expand_sdk}.

  7. The operation responds with an array of Application objects.

Create an application

Creates a new application configuration.

POST /crux/v1/mgmt-pop/apps{?contractId}

Sample: /crux/v1/mgmt-pop/apps?contractId=F-EMGSGV

Content-Type: application/json

Object type: Application

Download schema: application.json

Request body:

{
    "app_profile": 7,
    "app_type": 1,
    "name": "Example Application"
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Application

Download schema: application.json

Response body:

{
    "auth_type": 1,
    "saml_settings": [
        {
            "sp": {
                "dst_url": "",
                "encr_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                "default_relay_state": "",
                "encr_algo": "aes256-cbc",
                "req_verify": false,
                "slo_req_verify": false,
                "slo_bind": "redirect",
                "entity_id": "https://host.net/saml/sp/response",
                "resp_encr": false,
                "req_bind": "redirect",
                "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                "logout_bind": "post",
                "slo_url": "",
                "force_auth": true,
                "acs_url": "https://host.net/saml/sp/response",
                "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
            },
            "idp": {
                "self_signed": true,
                "ecp_resp_signature": false,
                "slo_url": "https://host.net/saml/idp/slo",
                "entity_id": "https://host.net/saml/idp/sso",
                "resp_bind": "post",
                "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----\n",
                "sign_algo": "SHA1",
                "ecp_enable": false,
                "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
            },
            "attrmap": [
                {
                    "src": "user.firstName",
                    "fmt": "unspecified",
                    "name": "FirstName",
                    "fname": ""
                },
                {
                    "src": "user.email",
                    "fmt": "basic",
                    "name": "Email",
                    "fname": ""
                },
                {
                    "src": "user.lastName",
                    "fmt": "basic",
                    "name": "LastName",
                    "fname": ""
                }
            ],
            "subject": {
                "attr_source": "user.email",
                "src": "user.userPrincipleName",
                "fmt": "unspecified"
            }
        }
    ],
    "domain": 1,
    "domain_suffix": "host.akamai-access.com",
    "app_status": 2,
    "popName": "us-pop-1",
    "pop": "LpeAuKXkEeOg_Q7rYYFrWw",
    "servers": [
        {
            "origin_host": "10.20.30.100",
            "orig_tls": true,
            "origin_port": 22,
            "origin_protocol": "ssh"
        }
    ],
    "services": [
        {
            "name": "Acceleration",
            "uuid_url": "YqQlGzjYRzuSX04"
        },
        {
            "name": "Access Control",
            "uuid_url": "RzuSX04c8CECtw15"
        }
    ],
    "agents": [
        {
            "compatible": true,
            "name": "Email-App-Connector",
            "uuid_url": "aldTFght_SfoolsooD26Q"
        },
        {
            "compatible": true,
            "name": "App2-Connector",
            "uuid_url": "askljgoSxmQnkfJ1fozTA"
        }
    ],
    "origin_host": null,
    "app_type": 2,
    "client_app_mode": 1,
    "app_deployed": true,
    "saml": true,
    "auth_agent": null,
    "sites": [
        "skljgoSxoolsooD26Q-qQlGzjYRzuS"
    ],
    "rdp_version": "V1",
    "auth_enabled": "true",
    "uuid_url": "ZgpmtAS0ORa2b0jF",
    "app_logo": "https://host.com/customer-logo/app_icon_<uuid_url>",
    "wsfed_settings": [],
    "advanced_settings": {
        "mfa": "inherit",
        "rdp_initial_program": null,
        "hidden_app": "false",
        "force_mfa": "off",
        "login_timeout": "5",
        "remote_spark_audio": "true",
        "sticky_agent": "false",
        "https_sslv3": "false",
        "authenticated_server_conn_limit": "50",
        "idle_conn_step": "10",
        "idle_close_time_seconds": "1200",
        "logout_url": null,
        "keyed_keepalive_enable": "false",
        "idle_conn_floor": "50",
        "cors_origin_list": "unbounded",
        "health_check_http_host_header": "",
        "session_sticky_cookie_maxage": "0",
        "ssh_audit_enabled": "false",
        "app_auth_domain": null,
        "edge_authentication_enabled": "false",
        "sso": "true",
        "preauth_enforce_url": "",
        "remote_spark_mapClipboard": "on",
        "keepalive_enable": "true",
        "health_check_interval": "30000",
        "idle_conn_ceil": "75",
        "proxy_buffer_size_kb": null,
        "forward_ticket_granting_ticket": "false",
        "websocket_enabled": "false",
        "internal_host_port": "0",
        "authenticated_server_request_limit": "100",
        "g2o_nonce": null,
        "server_request_burst": "100",
        "keepalive_connection_pool": "50",
        "keytab": "",
        "saas_enabled": "false",
        "health_check_http_url": "/",
        "cors_max_age": "86400",
        "inject_ajax_javascript": "off",
        "spdy_enabled": "true",
        "health_check_fall": "3",
        "anonymous_server_conn_limit": "50",
        "client_cert_auth": "false",
        "remote_spark_mapPrinter": "true",
        "domain_exception_list": "",
        "idp_idle_expiry": null,
        "kerberos_negotiate_once": "off",
        "proxy_disable_clipboard": "false",
        "external_cookie_domain": null,
        "app_server_read_timeout": "60",
        "rdp_remote_apps": [],
        "load_balancing_metric": "round-robin",
        "keepalive_timeout": "3",
        "app_location": null,
        "health_check_http_version": "1.1",
        "offload_onpremise_traffic": "false",
        "session_sticky": "false",
        "sentry_redirect_401": "off",
        "remote_spark_disk": "LOCALSHARE",
        "refresh_sticky_cookie": "on",
        "ignore_cname_resolution": "false",
        "user_name": null,
        "http_only_cookie": "true",
        "login_url": null,
        "anonymous_server_request_limit": "100",
        "session_sticky_server_cookie": null,
        "request_body_rewrite": "false",
        "sla_object_url": "____spx/iontestpage",
        "custom_headers": [],
        "pass_phrase": null,
        "edge_cookie_key": "",
        "g2o_key": null,
        "request_parameters": null,
        "wildcard_internal_hostname": "false",
        "logging_enabled": "true",
        "server_cert_validate": "true",
        "rate_limit": "on",
        "rdp_tls1": "false",
        "health_check_timeout": "50000",
        "health_check_rise": "2",
        "g2o_enabled": "false",
        "internal_hostname": "",
        "app_auth": "none",
        "cors_support_credential": "on",
        "cors_header_list": "unbounded",
        "acceleration": "false",
        "remote_spark_mapDisk": "true",
        "hsts_age": "15552000",
        "remote_spark_printer": "LOCALPRINTER",
        "allow_cors": "false",
        "rdp_legacy_mode": "false",
        "cors_method_list": "unbounded",
        "private_key": null,
        "app_cookie_domain": null,
        "service_principle_name": null,
        "app_client_cert_auth": "false",
        "cookie_domain": "",
        "remote_spark_recording": "false",
        "idp_max_expiry": null,
        "wapp_auth": "form",
        "health_check_type": "0",
        "client_cert_user_param": ""
    },
    "app_category": {
        "name": "Communications",
        "uuid_url": "CNasdlkfjlkasdhftZjKIFA"
    },
    "description": "This is the Email Server",
    "app_profile": 1,
    "resource_status": {
        "host_reachable": false,
        "directories_status": 2,
        "origin_host_status": 4,
        "cname_dns_status": 1,
        "data_agent_status": 1,
        "cert_status": 1,
        "host_dns_status": 4,
        "internal_host_status": 1,
        "dialin_server_status": 4,
        "pop_status": 2
    },
    "host": "<uuid_url>.host.akamai-access.com",
    "data_agent": null,
    "orig_tls": "true",
    "origin_port": 443,
    "bookmark_url": "",
    "app_operational": 3,
    "resource": "apps",
    "name": "Primary Email Application",
    "oidc_settings": {},
    "directories": [
        {
            "user_count": 29584,
            "type": 1,
            "name": "Company-Primary-AD",
            "uuid_url": "_tvruiywwiyipwgvs8rw"
        }
    ],
    "modified_at": "2019-03-28T20:10:22.418270",
    "idp": {
        "idp_id": "aMEgMEgeToipiytpeP1u5kLg",
        "client_cert_auth": "false",
        "client_cert_user_param": "",
        "name": "Pri-SAML-IDP",
        "type": 2
    },
    "cert": null,
    "cname": "<uuid_url>.host.akamai-access.com",
    "status": 1,
    "wsfed": false,
    "oidc": false,
    "created_at": "2017-10-09T21:21:27.548211",
    "resource_uri": {
        "directories": "/api/v1/apps/uuid_url/directories/",
        "sites": "/api/v1/apps/<uuid_url>/sites",
        "pop": "/api/v1/pops/<pop>",
        "href": "/api/v1/apps/<uuid_url>",
        "groups": "/api/v1/apps/<uuid_url>/groups/",
        "services": "/api/v1/apps/<uuid_url>/services/"
    }
}

  1. Ensure you have your contractId query parameter.

  2. Build a new Application object.

  3. POST the object to /crux/v1/mgmt-pop/apps{?contractId}.

  4. The operation responds with an Application object.

Get an application

Returns a specified application configuration.

GET /crux/v1/mgmt-pop/apps/{applicationId}{?contractId,expand,expand_sdk}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV&expand=true&expand_sdk=true

Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.
expand_sdk Boolean true When set to true, the application members include services and directories.

Status 200 application/json

Object type: Application

Download schema: application.json

Response body:

{
    "auth_type": 1,
    "saml_settings": [
        {
            "sp": {
                "dst_url": "",
                "encr_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                "default_relay_state": "",
                "encr_algo": "aes256-cbc",
                "req_verify": false,
                "slo_req_verify": false,
                "slo_bind": "redirect",
                "entity_id": "https://host.net/saml/sp/response",
                "resp_encr": false,
                "req_bind": "redirect",
                "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                "logout_bind": "post",
                "slo_url": "",
                "force_auth": true,
                "acs_url": "https://host.net/saml/sp/response",
                "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
            },
            "idp": {
                "self_signed": true,
                "ecp_resp_signature": false,
                "slo_url": "https://host.net/saml/idp/slo",
                "entity_id": "https://host.net/saml/idp/sso",
                "resp_bind": "post",
                "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----\n",
                "sign_algo": "SHA1",
                "ecp_enable": false,
                "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
            },
            "attrmap": [
                {
                    "src": "user.firstName",
                    "fmt": "unspecified",
                    "name": "FirstName",
                    "fname": ""
                },
                {
                    "src": "user.email",
                    "fmt": "basic",
                    "name": "Email",
                    "fname": ""
                },
                {
                    "src": "user.lastName",
                    "fmt": "basic",
                    "name": "LastName",
                    "fname": ""
                }
            ],
            "subject": {
                "attr_source": "user.email",
                "src": "user.userPrincipleName",
                "fmt": "unspecified"
            }
        }
    ],
    "domain": 1,
    "domain_suffix": "host.akamai-access.com",
    "app_status": 2,
    "popName": "us-pop-1",
    "pop": "LpeAuKXkEeOg_Q7rYYFrWw",
    "servers": [
        {
            "origin_host": "10.20.30.100",
            "orig_tls": true,
            "origin_port": 22,
            "origin_protocol": "ssh"
        }
    ],
    "services": [
        {
            "name": "Acceleration",
            "uuid_url": "YqQlGzjYRzuSX04"
        },
        {
            "name": "Access Control",
            "uuid_url": "RzuSX04c8CECtw15"
        }
    ],
    "agents": [
        {
            "compatible": true,
            "name": "Email-App-Connector",
            "uuid_url": "aldTFght_SfoolsooD26Q"
        },
        {
            "compatible": true,
            "name": "App2-Connector",
            "uuid_url": "askljgoSxmQnkfJ1fozTA"
        }
    ],
    "origin_host": null,
    "app_type": 2,
    "client_app_mode": 1,
    "app_deployed": true,
    "saml": true,
    "auth_agent": null,
    "sites": [
        "skljgoSxoolsooD26Q-qQlGzjYRzuS"
    ],
    "rdp_version": "V1",
    "auth_enabled": "true",
    "uuid_url": "ZgpmtAS0ORa2b0jF",
    "app_logo": "https://host.com/customer-logo/app_icon_<uuid_url>",
    "wsfed_settings": [],
    "advanced_settings": {
        "mfa": "inherit",
        "rdp_initial_program": null,
        "hidden_app": "false",
        "force_mfa": "off",
        "login_timeout": "5",
        "remote_spark_audio": "true",
        "sticky_agent": "false",
        "https_sslv3": "false",
        "authenticated_server_conn_limit": "50",
        "idle_conn_step": "10",
        "idle_close_time_seconds": "1200",
        "logout_url": null,
        "keyed_keepalive_enable": "false",
        "idle_conn_floor": "50",
        "cors_origin_list": "unbounded",
        "health_check_http_host_header": "",
        "session_sticky_cookie_maxage": "0",
        "ssh_audit_enabled": "false",
        "app_auth_domain": null,
        "edge_authentication_enabled": "false",
        "sso": "true",
        "preauth_enforce_url": "",
        "remote_spark_mapClipboard": "on",
        "keepalive_enable": "true",
        "health_check_interval": "30000",
        "idle_conn_ceil": "75",
        "proxy_buffer_size_kb": null,
        "forward_ticket_granting_ticket": "false",
        "websocket_enabled": "false",
        "internal_host_port": "0",
        "authenticated_server_request_limit": "100",
        "g2o_nonce": null,
        "server_request_burst": "100",
        "keepalive_connection_pool": "50",
        "keytab": "",
        "saas_enabled": "false",
        "health_check_http_url": "/",
        "cors_max_age": "86400",
        "inject_ajax_javascript": "off",
        "spdy_enabled": "true",
        "health_check_fall": "3",
        "anonymous_server_conn_limit": "50",
        "client_cert_auth": "false",
        "remote_spark_mapPrinter": "true",
        "domain_exception_list": "",
        "idp_idle_expiry": null,
        "kerberos_negotiate_once": "off",
        "proxy_disable_clipboard": "false",
        "external_cookie_domain": null,
        "app_server_read_timeout": "60",
        "rdp_remote_apps": [],
        "load_balancing_metric": "round-robin",
        "keepalive_timeout": "3",
        "app_location": null,
        "health_check_http_version": "1.1",
        "offload_onpremise_traffic": "false",
        "session_sticky": "false",
        "sentry_redirect_401": "off",
        "remote_spark_disk": "LOCALSHARE",
        "refresh_sticky_cookie": "on",
        "ignore_cname_resolution": "false",
        "user_name": null,
        "http_only_cookie": "true",
        "login_url": null,
        "anonymous_server_request_limit": "100",
        "session_sticky_server_cookie": null,
        "request_body_rewrite": "false",
        "sla_object_url": "____spx/iontestpage",
        "custom_headers": [],
        "pass_phrase": null,
        "edge_cookie_key": "",
        "g2o_key": null,
        "request_parameters": null,
        "wildcard_internal_hostname": "false",
        "logging_enabled": "true",
        "server_cert_validate": "true",
        "rate_limit": "on",
        "rdp_tls1": "false",
        "health_check_timeout": "50000",
        "health_check_rise": "2",
        "g2o_enabled": "false",
        "internal_hostname": "",
        "app_auth": "none",
        "cors_support_credential": "on",
        "cors_header_list": "unbounded",
        "acceleration": "false",
        "remote_spark_mapDisk": "true",
        "hsts_age": "15552000",
        "remote_spark_printer": "LOCALPRINTER",
        "allow_cors": "false",
        "rdp_legacy_mode": "false",
        "cors_method_list": "unbounded",
        "private_key": null,
        "app_cookie_domain": null,
        "service_principle_name": null,
        "app_client_cert_auth": "false",
        "cookie_domain": "",
        "remote_spark_recording": "false",
        "idp_max_expiry": null,
        "wapp_auth": "form",
        "health_check_type": "0",
        "client_cert_user_param": ""
    },
    "app_category": {
        "name": "Communications",
        "uuid_url": "CNasdlkfjlkasdhftZjKIFA"
    },
    "description": "This is the Email Server",
    "app_profile": 1,
    "resource_status": {
        "host_reachable": false,
        "directories_status": 2,
        "origin_host_status": 4,
        "cname_dns_status": 1,
        "data_agent_status": 1,
        "cert_status": 1,
        "host_dns_status": 4,
        "internal_host_status": 1,
        "dialin_server_status": 4,
        "pop_status": 2
    },
    "host": "<uuid_url>.host.akamai-access.com",
    "data_agent": null,
    "orig_tls": "true",
    "origin_port": 443,
    "bookmark_url": "",
    "app_operational": 3,
    "resource": "apps",
    "name": "Primary Email Application",
    "oidc_settings": {},
    "directories": [
        {
            "user_count": 29584,
            "type": 1,
            "name": "Company-Primary-AD",
            "uuid_url": "_tvruiywwiyipwgvs8rw"
        }
    ],
    "modified_at": "2019-03-28T20:10:22.418270",
    "idp": {
        "idp_id": "aMEgMEgeToipiytpeP1u5kLg",
        "client_cert_auth": "false",
        "client_cert_user_param": "",
        "name": "Pri-SAML-IDP",
        "type": 2
    },
    "cert": null,
    "cname": "<uuid_url>.host.akamai-access.com",
    "status": 1,
    "wsfed": false,
    "oidc": false,
    "created_at": "2017-10-09T21:21:27.548211",
    "resource_uri": {
        "directories": "/api/v1/apps/uuid_url/directories/",
        "sites": "/api/v1/apps/<uuid_url>/sites",
        "pop": "/api/v1/pops/<pop>",
        "href": "/api/v1/apps/<uuid_url>",
        "groups": "/api/v1/apps/<uuid_url>/groups/",
        "services": "/api/v1/apps/<uuid_url>/services/"
    }
}

  1. Run the List applications operation and store the relevant applicationId.

  2. Optionally, set expand to true to include additional members in the response.

  3. Optionally, set expand_sdk to true to include services and directories in the response.

  4. Make a GET request to /crux/v1/mgmt-pop/apps/{applicationId}{?expand,expand_sdk}.

  5. The operation responds with an Application object.

Modify an application

Updates the details of an application configuration.

PUT /crux/v1/mgmt-pop/apps/{applicationId}{?contractId}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Content-Type: application/json

Object type: Application

Download schema: application.json

Request body:

{
    "auth_type": 1,
    "saml_settings": [
        {
            "sp": {
                "dst_url": "",
                "encr_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                "default_relay_state": "",
                "encr_algo": "aes256-cbc",
                "req_verify": false,
                "slo_req_verify": false,
                "slo_bind": "redirect",
                "entity_id": "https://host.net/saml/sp/response",
                "resp_encr": false,
                "req_bind": "redirect",
                "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                "logout_bind": "post",
                "slo_url": "",
                "force_auth": true,
                "acs_url": "https://host.net/saml/sp/response",
                "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
            },
            "idp": {
                "self_signed": true,
                "ecp_resp_signature": false,
                "slo_url": "https://host.net/saml/idp/slo",
                "entity_id": "https://host.net/saml/idp/sso",
                "resp_bind": "post",
                "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----\n",
                "sign_algo": "SHA1",
                "ecp_enable": false,
                "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
            },
            "attrmap": [
                {
                    "src": "user.firstName",
                    "fmt": "unspecified",
                    "name": "FirstName",
                    "fname": ""
                },
                {
                    "src": "user.email",
                    "fmt": "basic",
                    "name": "Email",
                    "fname": ""
                },
                {
                    "src": "user.lastName",
                    "fmt": "basic",
                    "name": "LastName",
                    "fname": ""
                }
            ],
            "subject": {
                "attr_source": "user.email",
                "src": "user.userPrincipleName",
                "fmt": "unspecified"
            }
        }
    ],
    "domain": 1,
    "domain_suffix": "host.akamai-access.com",
    "app_status": 2,
    "popName": "us-pop-1",
    "pop": "LpeAuKXkEeOg_Q7rYYFrWw",
    "servers": [
        {
            "origin_host": "10.20.30.100",
            "orig_tls": true,
            "origin_port": 22,
            "origin_protocol": "ssh"
        }
    ],
    "services": [
        {
            "name": "Acceleration",
            "uuid_url": "YqQlGzjYRzuSX04"
        },
        {
            "name": "Access Control",
            "uuid_url": "RzuSX04c8CECtw15"
        }
    ],
    "agents": [
        {
            "compatible": true,
            "name": "Email-App-Connector",
            "uuid_url": "aldTFght_SfoolsooD26Q"
        },
        {
            "compatible": true,
            "name": "App2-Connector",
            "uuid_url": "askljgoSxmQnkfJ1fozTA"
        }
    ],
    "origin_host": null,
    "app_type": 2,
    "client_app_mode": 1,
    "app_deployed": true,
    "saml": true,
    "auth_agent": null,
    "sites": [
        "skljgoSxoolsooD26Q-qQlGzjYRzuS"
    ],
    "rdp_version": "V1",
    "auth_enabled": "true",
    "uuid_url": "ZgpmtAS0ORa2b0jF",
    "app_logo": "https://host.com/customer-logo/app_icon_<uuid_url>",
    "wsfed_settings": [],
    "advanced_settings": {
        "mfa": "inherit",
        "rdp_initial_program": null,
        "hidden_app": "false",
        "force_mfa": "off",
        "login_timeout": "5",
        "remote_spark_audio": "true",
        "sticky_agent": "false",
        "https_sslv3": "false",
        "authenticated_server_conn_limit": "50",
        "idle_conn_step": "10",
        "idle_close_time_seconds": "1200",
        "logout_url": null,
        "keyed_keepalive_enable": "false",
        "idle_conn_floor": "50",
        "cors_origin_list": "unbounded",
        "health_check_http_host_header": "",
        "session_sticky_cookie_maxage": "0",
        "ssh_audit_enabled": "false",
        "app_auth_domain": null,
        "edge_authentication_enabled": "false",
        "sso": "true",
        "preauth_enforce_url": "",
        "remote_spark_mapClipboard": "on",
        "keepalive_enable": "true",
        "health_check_interval": "30000",
        "idle_conn_ceil": "75",
        "proxy_buffer_size_kb": null,
        "forward_ticket_granting_ticket": "false",
        "websocket_enabled": "false",
        "internal_host_port": "0",
        "authenticated_server_request_limit": "100",
        "g2o_nonce": null,
        "server_request_burst": "100",
        "keepalive_connection_pool": "50",
        "keytab": "",
        "saas_enabled": "false",
        "health_check_http_url": "/",
        "cors_max_age": "86400",
        "inject_ajax_javascript": "off",
        "spdy_enabled": "true",
        "health_check_fall": "3",
        "anonymous_server_conn_limit": "50",
        "client_cert_auth": "false",
        "remote_spark_mapPrinter": "true",
        "domain_exception_list": "",
        "idp_idle_expiry": null,
        "kerberos_negotiate_once": "off",
        "proxy_disable_clipboard": "false",
        "external_cookie_domain": null,
        "app_server_read_timeout": "60",
        "rdp_remote_apps": [],
        "load_balancing_metric": "round-robin",
        "keepalive_timeout": "3",
        "app_location": null,
        "health_check_http_version": "1.1",
        "offload_onpremise_traffic": "false",
        "session_sticky": "false",
        "sentry_redirect_401": "off",
        "remote_spark_disk": "LOCALSHARE",
        "refresh_sticky_cookie": "on",
        "ignore_cname_resolution": "false",
        "user_name": null,
        "http_only_cookie": "true",
        "login_url": null,
        "anonymous_server_request_limit": "100",
        "session_sticky_server_cookie": null,
        "request_body_rewrite": "false",
        "sla_object_url": "____spx/iontestpage",
        "custom_headers": [],
        "pass_phrase": null,
        "edge_cookie_key": "",
        "g2o_key": null,
        "request_parameters": null,
        "wildcard_internal_hostname": "false",
        "logging_enabled": "true",
        "server_cert_validate": "true",
        "rate_limit": "on",
        "rdp_tls1": "false",
        "health_check_timeout": "50000",
        "health_check_rise": "2",
        "g2o_enabled": "false",
        "internal_hostname": "",
        "app_auth": "none",
        "cors_support_credential": "on",
        "cors_header_list": "unbounded",
        "acceleration": "false",
        "remote_spark_mapDisk": "true",
        "hsts_age": "15552000",
        "remote_spark_printer": "LOCALPRINTER",
        "allow_cors": "false",
        "rdp_legacy_mode": "false",
        "cors_method_list": "unbounded",
        "private_key": null,
        "app_cookie_domain": null,
        "service_principle_name": null,
        "app_client_cert_auth": "false",
        "cookie_domain": "",
        "remote_spark_recording": "false",
        "idp_max_expiry": null,
        "wapp_auth": "form",
        "health_check_type": "0",
        "client_cert_user_param": ""
    },
    "app_category": {
        "name": "Communications",
        "uuid_url": "CNasdlkfjlkasdhftZjKIFA"
    },
    "description": "This is the Email Server",
    "app_profile": 1,
    "resource_status": {
        "host_reachable": false,
        "directories_status": 2,
        "origin_host_status": 4,
        "cname_dns_status": 1,
        "data_agent_status": 1,
        "cert_status": 1,
        "host_dns_status": 4,
        "internal_host_status": 1,
        "dialin_server_status": 4,
        "pop_status": 2
    },
    "host": "<uuid_url>.host.akamai-access.com",
    "data_agent": null,
    "orig_tls": "true",
    "origin_port": 443,
    "bookmark_url": "",
    "app_operational": 3,
    "resource": "apps",
    "name": "Primary Email Application",
    "oidc_settings": {},
    "directories": [
        {
            "user_count": 29584,
            "type": 1,
            "name": "Company-Primary-AD",
            "uuid_url": "_tvruiywwiyipwgvs8rw"
        }
    ],
    "idp": {
        "idp_id": "aMEgMEgeToipiytpeP1u5kLg",
        "client_cert_auth": "false",
        "client_cert_user_param": "",
        "name": "Pri-SAML-IDP",
        "type": 2
    },
    "cert": null,
    "cname": "<uuid_url>.host.akamai-access.com",
    "status": 1,
    "wsfed": false,
    "oidc": false,
    "resource_uri": {
        "directories": "/api/v1/apps/uuid_url/directories/",
        "sites": "/api/v1/apps/<uuid_url>/sites",
        "pop": "/api/v1/pops/<pop>",
        "href": "/api/v1/apps/<uuid_url>",
        "groups": "/api/v1/apps/<uuid_url>/groups/",
        "services": "/api/v1/apps/<uuid_url>/services/"
    }
}
Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Application

Download schema: application.json

Response body:

{
    "auth_type": 1,
    "saml_settings": [
        {
            "sp": {
                "dst_url": "",
                "encr_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                "default_relay_state": "",
                "encr_algo": "aes256-cbc",
                "req_verify": false,
                "slo_req_verify": false,
                "slo_bind": "redirect",
                "entity_id": "https://host.net/saml/sp/response",
                "resp_encr": false,
                "req_bind": "redirect",
                "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----",
                "logout_bind": "post",
                "slo_url": "",
                "force_auth": true,
                "acs_url": "https://host.net/saml/sp/response",
                "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
            },
            "idp": {
                "self_signed": true,
                "ecp_resp_signature": false,
                "slo_url": "https://host.net/saml/idp/slo",
                "entity_id": "https://host.net/saml/idp/sso",
                "resp_bind": "post",
                "sign_cert": "-----BEGIN CERTIFICATE-----\n ... \n-----END CERTIFICATE-----\n",
                "sign_algo": "SHA1",
                "ecp_enable": false,
                "metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor> ... </md:EntityDescriptor>"
            },
            "attrmap": [
                {
                    "src": "user.firstName",
                    "fmt": "unspecified",
                    "name": "FirstName",
                    "fname": ""
                },
                {
                    "src": "user.email",
                    "fmt": "basic",
                    "name": "Email",
                    "fname": ""
                },
                {
                    "src": "user.lastName",
                    "fmt": "basic",
                    "name": "LastName",
                    "fname": ""
                }
            ],
            "subject": {
                "attr_source": "user.email",
                "src": "user.userPrincipleName",
                "fmt": "unspecified"
            }
        }
    ],
    "domain": 1,
    "domain_suffix": "host.akamai-access.com",
    "app_status": 2,
    "popName": "us-pop-1",
    "pop": "LpeAuKXkEeOg_Q7rYYFrWw",
    "servers": [
        {
            "origin_host": "10.20.30.100",
            "orig_tls": true,
            "origin_port": 22,
            "origin_protocol": "ssh"
        }
    ],
    "services": [
        {
            "name": "Acceleration",
            "uuid_url": "YqQlGzjYRzuSX04"
        },
        {
            "name": "Access Control",
            "uuid_url": "RzuSX04c8CECtw15"
        }
    ],
    "agents": [
        {
            "compatible": true,
            "name": "Email-App-Connector",
            "uuid_url": "aldTFght_SfoolsooD26Q"
        },
        {
            "compatible": true,
            "name": "App2-Connector",
            "uuid_url": "askljgoSxmQnkfJ1fozTA"
        }
    ],
    "origin_host": null,
    "app_type": 2,
    "client_app_mode": 1,
    "app_deployed": true,
    "saml": true,
    "auth_agent": null,
    "sites": [
        "skljgoSxoolsooD26Q-qQlGzjYRzuS"
    ],
    "rdp_version": "V1",
    "auth_enabled": "true",
    "uuid_url": "ZgpmtAS0ORa2b0jF",
    "app_logo": "https://host.com/customer-logo/app_icon_<uuid_url>",
    "wsfed_settings": [],
    "advanced_settings": {
        "mfa": "inherit",
        "rdp_initial_program": null,
        "hidden_app": "false",
        "force_mfa": "off",
        "login_timeout": "5",
        "remote_spark_audio": "true",
        "sticky_agent": "false",
        "https_sslv3": "false",
        "authenticated_server_conn_limit": "50",
        "idle_conn_step": "10",
        "idle_close_time_seconds": "1200",
        "logout_url": null,
        "keyed_keepalive_enable": "false",
        "idle_conn_floor": "50",
        "cors_origin_list": "unbounded",
        "health_check_http_host_header": "",
        "session_sticky_cookie_maxage": "0",
        "ssh_audit_enabled": "false",
        "app_auth_domain": null,
        "edge_authentication_enabled": "false",
        "sso": "true",
        "preauth_enforce_url": "",
        "remote_spark_mapClipboard": "on",
        "keepalive_enable": "true",
        "health_check_interval": "30000",
        "idle_conn_ceil": "75",
        "proxy_buffer_size_kb": null,
        "forward_ticket_granting_ticket": "false",
        "websocket_enabled": "false",
        "internal_host_port": "0",
        "authenticated_server_request_limit": "100",
        "g2o_nonce": null,
        "server_request_burst": "100",
        "keepalive_connection_pool": "50",
        "keytab": "",
        "saas_enabled": "false",
        "health_check_http_url": "/",
        "cors_max_age": "86400",
        "inject_ajax_javascript": "off",
        "spdy_enabled": "true",
        "health_check_fall": "3",
        "anonymous_server_conn_limit": "50",
        "client_cert_auth": "false",
        "remote_spark_mapPrinter": "true",
        "domain_exception_list": "",
        "idp_idle_expiry": null,
        "kerberos_negotiate_once": "off",
        "proxy_disable_clipboard": "false",
        "external_cookie_domain": null,
        "app_server_read_timeout": "60",
        "rdp_remote_apps": [],
        "load_balancing_metric": "round-robin",
        "keepalive_timeout": "3",
        "app_location": null,
        "health_check_http_version": "1.1",
        "offload_onpremise_traffic": "false",
        "session_sticky": "false",
        "sentry_redirect_401": "off",
        "remote_spark_disk": "LOCALSHARE",
        "refresh_sticky_cookie": "on",
        "ignore_cname_resolution": "false",
        "user_name": null,
        "http_only_cookie": "true",
        "login_url": null,
        "anonymous_server_request_limit": "100",
        "session_sticky_server_cookie": null,
        "request_body_rewrite": "false",
        "sla_object_url": "____spx/iontestpage",
        "custom_headers": [],
        "pass_phrase": null,
        "edge_cookie_key": "",
        "g2o_key": null,
        "request_parameters": null,
        "wildcard_internal_hostname": "false",
        "logging_enabled": "true",
        "server_cert_validate": "true",
        "rate_limit": "on",
        "rdp_tls1": "false",
        "health_check_timeout": "50000",
        "health_check_rise": "2",
        "g2o_enabled": "false",
        "internal_hostname": "",
        "app_auth": "none",
        "cors_support_credential": "on",
        "cors_header_list": "unbounded",
        "acceleration": "false",
        "remote_spark_mapDisk": "true",
        "hsts_age": "15552000",
        "remote_spark_printer": "LOCALPRINTER",
        "allow_cors": "false",
        "rdp_legacy_mode": "false",
        "cors_method_list": "unbounded",
        "private_key": null,
        "app_cookie_domain": null,
        "service_principle_name": null,
        "app_client_cert_auth": "false",
        "cookie_domain": "",
        "remote_spark_recording": "false",
        "idp_max_expiry": null,
        "wapp_auth": "form",
        "health_check_type": "0",
        "client_cert_user_param": ""
    },
    "app_category": {
        "name": "Communications",
        "uuid_url": "CNasdlkfjlkasdhftZjKIFA"
    },
    "description": "This is the Email Server",
    "app_profile": 1,
    "resource_status": {
        "host_reachable": false,
        "directories_status": 2,
        "origin_host_status": 4,
        "cname_dns_status": 1,
        "data_agent_status": 1,
        "cert_status": 1,
        "host_dns_status": 4,
        "internal_host_status": 1,
        "dialin_server_status": 4,
        "pop_status": 2
    },
    "host": "<uuid_url>.host.akamai-access.com",
    "data_agent": null,
    "orig_tls": "true",
    "origin_port": 443,
    "bookmark_url": "",
    "app_operational": 3,
    "resource": "apps",
    "name": "Primary Email Application",
    "oidc_settings": {},
    "directories": [
        {
            "user_count": 29584,
            "type": 1,
            "name": "Company-Primary-AD",
            "uuid_url": "_tvruiywwiyipwgvs8rw"
        }
    ],
    "modified_at": "2019-03-28T20:10:22.418270",
    "idp": {
        "idp_id": "aMEgMEgeToipiytpeP1u5kLg",
        "client_cert_auth": "false",
        "client_cert_user_param": "",
        "name": "Pri-SAML-IDP",
        "type": 2
    },
    "cert": null,
    "cname": "<uuid_url>.host.akamai-access.com",
    "status": 1,
    "wsfed": false,
    "oidc": false,
    "created_at": "2017-10-09T21:21:27.548211",
    "resource_uri": {
        "directories": "/api/v1/apps/uuid_url/directories/",
        "sites": "/api/v1/apps/<uuid_url>/sites",
        "pop": "/api/v1/pops/<pop>",
        "href": "/api/v1/apps/<uuid_url>",
        "groups": "/api/v1/apps/<uuid_url>/groups/",
        "services": "/api/v1/apps/<uuid_url>/services/"
    }
}

  1. Run the List applications operation and store the relevant applicationId.

  2. Run the Get an application operation and store the response object.

  3. Modify the Application object.

  4. PUT the object to /crux/v1/mgmt-pop/apps/{applicationId}.

  5. The operation responds with an Application object.

Delete an application

Removes an application configuration.

DELETE /crux/v1/mgmt-pop/apps/{applicationId}{?contractId}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 204

  1. Run the List applications operation and store the relevant applicationId.

  2. Make a DELETE request to /crux/v1/mgmt-pop/apps/{applicationId}.

Create a G2O key

Enables a G2O configuration for an application configuration.

POST /crux/v1/mgmt-pop/apps/{applicationId}/g2o{?contractId}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA/g2o?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: G2O

Download schema: g2o.json

Response body:

{
    "g2o_key": "a719dbd96 ... 3561d96d4c",
    "g2o_enabled": "true",
    "g2o_nonce": "b59f6a5a"
}

  1. Run the List applications operation and store the relevant applicationId.

  2. Ensure you have your contractId query parameter.

  3. Make a POST request to /crux/v1/mgmt-pop/apps/{applicationId}/g2o{?contractId}.

  4. The operation responds with a G2O object.

Create an edge key

Generates an edge key for an application configuration.

POST /crux/v1/mgmt-pop/apps/{applicationId}/edgekey{?contractId}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA/edgekey?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: EdgeKey

Download schema: edge-key.json

Response body:

{
    "sla_object_url": "____spx/iontestpage",
    "edge_cookie_key": "bdbd496d5 ... 13282ed58"
}

  1. Run the List applications operation and store the relevant applicationId.

  2. Ensure you have your contractId query parameter.

  3. Make a POST request to /crux/v1/mgmt-pop/apps/{applicationId}/edgekey{?contractId}.

List services for an application

Lists the details of the services for an application configuration.

GET /crux/v1/mgmt-pop/apps/{applicationId}/services{?contractId,expand}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA/services?contractId=F-EMGSGV&expand=true

Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.

Status 200 application/json

Download schema: services-for-application.json

Response body:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 5
    },
    "objects": [
        {
            "app": {
                "app_uuid_url": "3JEFvcNxRKCoQk-al9PAZw",
                "name": "Dev Application"
            },
            "resource": "appservices",
            "resource_uri": {
                "apps": "/api/v1/apps/3JEFvcNxRKCoQk-al9PAZw",
                "href": "/api/v1/appservices/aHfEPDp_RU2wN9qennJbow",
                "services": "/api/v1/services/yl3eapQoTAyIeE_VSJQChw"
            },
            "service": {
                "description": null,
                "name": "Acceleration",
                "service_type": 2,
                "settings": {
                    "compression": "on"
                },
                "status": "on",
                "uuid_url": "yl3eapQoTAyIeE_VSJQChw"
            },
            "status": 1,
            "uuid_url": "aHfEPDp_RU2wN9qennJbow"
        },
        {
            "app": {
                "app_uuid_url": "3JEFvcNxRKCoQk-al9PAZw",
                "name": "Dev Application"
            },
            "resource": "appservices",
            "resource_uri": {
                "apps": "/api/v1/apps/3JEFvcNxRKCoQk-al9PAZw",
                "href": "/api/v1/appservices/oG9K1x42T3CATo58tJMcQQ",
                "services": "/api/v1/services/K-7IH7AaTj-2fOLjt1xsVg"
            },
            "service": {
                "description": null,
                "name": "WAF",
                "service_type": 1,
                "settings": {
                    "bad_robots": "Off",
                    "http_policy": "Off",
                    "illegal_resource_access": "Off",
                    "joomla": "Off",
                    "php": "Off",
                    "protocol_anomalies": "Off",
                    "protocol_violations": "Off",
                    "request_limits": "Off",
                    "sql_injection": "Off",
                    "wordpress": "Off",
                    "xss_attack": "Off"
                },
                "status": "off",
                "uuid_url": "K-7IH7AaTj-2fOLjt1xsVg"
            },
            "status": 1,
            "uuid_url": "oG9K1x42T3CATo58tJMcQQ"
        },
        {
            "app": {
                "app_uuid_url": "3JEFvcNxRKCoQk-al9PAZw",
                "name": "Dev Application"
            },
            "resource": "appservices",
            "resource_uri": {
                "apps": "/api/v1/apps/3JEFvcNxRKCoQk-al9PAZw",
                "href": "/api/v1/appservices/6onKim7vR-yCaFBMpDymqA",
                "services": "/api/v1/services/mz93Krl6QqKUTG1ivXV9og"
            },
            "service": {
                "description": null,
                "name": "Access Control",
                "service_type": 6,
                "settings": {},
                "status": "on",
                "uuid_url": "mz93Krl6QqKUTG1ivXV9og"
            },
            "status": 1,
            "uuid_url": "6onKim7vR-yCaFBMpDymqA"
        },
        {
            "app": {
                "app_uuid_url": "3JEFvcNxRKCoQk-al9PAZw",
                "name": "Dev Application"
            },
            "resource": "appservices",
            "resource_uri": {
                "apps": "/api/v1/apps/3JEFvcNxRKCoQk-al9PAZw",
                "href": "/api/v1/appservices/lV9d_mqjTxeL6rQG56MIWA",
                "services": "/api/v1/services/I-IYJYo3Qv2Dpys7zzRwKA"
            },
            "service": {
                "description": null,
                "name": "Rewrite",
                "service_type": 7,
                "settings": {},
                "status": "on",
                "uuid_url": "I-IYJYo3Qv2Dpys7zzRwKA"
            },
            "status": 1,
            "uuid_url": "lV9d_mqjTxeL6rQG56MIWA"
        },
        {
            "app": {
                "app_uuid_url": "3JEFvcNxRKCoQk-al9PAZw",
                "name": "Dev Application"
            },
            "resource": "appservices",
            "resource_uri": {
                "apps": "/api/v1/apps/3JEFvcNxRKCoQk-al9PAZw",
                "href": "/api/v1/appservices/sDK9DXYPQcS_RiLjjE0uTA",
                "services": "/api/v1/services/u3V0QcQjTpytKT0Tv2ZbYg"
            },
            "service": {
                "description": null,
                "name": "ICAP Service",
                "service_type": 3,
                "settings": {
                    "icap_file_size": "500M",
                    "icap_file_size_allow": "deny",
                    "icap_hc_type": "icap",
                    "icap_host": "icap.host.com",
                    "icap_http_methods": "POST",
                    "icap_mime_types": "*",
                    "icap_port": 1344,
                    "icap_service": "sohaservice",
                    "icap_tls_enable": "on"
                },
                "status": "on",
                "uuid_url": "u3V0QcQjTpytKT0Tv2ZbYg"
            },
            "status": 1,
            "uuid_url": "sDK9DXYPQcS_RiLjjE0uTA"
        }
    ]
}

  1. Run the List applications operation and store the relevant applicationId.

  2. Ensure you have your contractId query parameter.

  3. Optionally, set expand to true to include additional members in the response.

  4. Make a GET request to /crux/v1/mgmt-pop/apps/{applicationId}/services{?contractId,expand}.

  5. The operation responds with an array of application service details.

List groups for application

Lists the details all groups for an application configuration.

GET /crux/v1/mgmt-pop/apps/{applicationId}/groups{?contractId,expand}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA/groups?contractId=F-EMGSGV&expand=true

Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.

Status 200 application/json

Download schema: sync-group-users.json

Response body:

{
    "meta": {
        "previous": null,
        "total_count": 3,
        "offset": 0,
        "limit": 20,
        "next": null
    },
    "objects": [
        {
            "status": 1,
            "user_count": 7,
            "resource": "groups",
            "description": null,
            "created_at": "2017-09-28T19:11:18.201248",
            "modified_at": "2017-09-28T19:11:18.201264",
            "uuid_url": "eHLt50Z6RQaUznwXD4sCRg",
            "resource_uri": {
                "directory": "/api/v1/directories/gKP_FhvmSFaomjpNaR7Z9Q/",
                "href": "/api/v1/groups/eHLt50Z6RQaUznwXD4sCRg",
                "users": "/api/v1/groups/eHLt50Z6RQaUznwXD4sCRg/users/",
                "permissions": "/api/v1/groups/eHLt50Z6RQaUznwXD4sCRg/permissions/"
            },
            "group_type": 1,
            "name": "Admins"
        },
        {
            "status": 1,
            "user_count": 8,
            "resource": "groups",
            "description": null,
            "created_at": "2017-09-28T19:11:18.204719",
            "modified_at": "2017-09-28T19:11:18.204737",
            "uuid_url": "78tYrV-IRTKJDk-DzySX6Q",
            "resource_uri": {
                "directory": "/api/v1/directories/gKP_FhvmSFaomjpNaR7Z9Q/",
                "href": "/api/v1/groups/78tYrV-IRTKJDk-DzySX6Q",
                "users": "/api/v1/groups/78tYrV-IRTKJDk-DzySX6Q/users/",
                "permissions": "/api/v1/groups/78tYrV-IRTKJDk-DzySX6Q/permissions/"
            },
            "group_type": 1,
            "name": "Users"
        },
        {
            "status": 1,
            "user_count": 17,
            "resource": "groups",
            "description": null,
            "created_at": "2017-09-28T19:11:18.213654",
            "modified_at": "2017-09-28T19:11:18.213671",
            "uuid_url": "AjnZv5GGTe6C9IEVUXl0Nw",
            "resource_uri": {
                "directory": "/api/v1/directories/0MREBOagSSKMgZt3l7GANw/",
                "href": "/api/v1/groups/AjnZv5GGTe6C9IEVUXl0Nw",
                "users": "/api/v1/groups/AjnZv5GGTe6C9IEVUXl0Nw/users/",
                "permissions": "/api/v1/groups/AjnZv5GGTe6C9IEVUXl0Nw/permissions/"
            },
            "group_type": 1,
            "name": "Admins"
        }
    ]
}

  1. Run the List application groups operation and store the relevant applicationId.

  2. Ensure you have your contractId query parameter.

  3. Optionally, set the expand query parameter.

  4. Make a GET request to /crux/v1/mgmt-pop/apps/{applicationId}/groups{?contractId,expand}.

  5. The operation responds with an array of AppGroup objects.

Deploy an application

Deploys an application configuration.

POST /crux/v1/mgmt-pop/apps/{applicationId}/deploy{?contractId}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA/deploy?contractId=F-EMGSGV

Content-Type: application/json

Request body:

{
    "deploy_note": "Deploying on 21st Sept"
}
Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: deploy-application.json

Response body:

{
    "cmdid": 7883826115006123
}

  1. Optionally, set expand to true to include additional members in the response.

  2. Ensure you have your contractId query parameter.

  3. Make a POST request to /crux/v1/mgmt-pop/apps/{applicationId}/deploy{?contractId}.

  4. The operation responds with an object containing the cmdid.

List agents

Returns a list of agents for an application configuration.

GET /crux/v1/mgmt-pop/apps/{applicationId}/agents{?contractId,offset,limit}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA/agents?contractId=F-EMGSGV&offset=10&limit=30

Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Response body:

{
    "meta": {
        "previous": null,
        "total_count": 2,
        "offset": 0,
        "limit": 1000,
        "next": null
    },
    "objects": [
        {
            "ip_addr": null,
            "setpwd_attempt": 1,
            "auth_service": true,
            "public_ip": null,
            "pwdsyncflag": false,
            "private_ip": null,
            "manual_override": false,
            "all_applications": [
                {
                    "app_status": 1,
                    "name": "Accessapp#1",
                    "uuid_url": "3Czu34blSkarRHafL2v8bQ"
                },
                {
                    "app_status": 1,
                    "name": "Singlehost#1",
                    "uuid_url": "6dKsWEyFQiO9s4couCfDjg"
                },
                {
                    "app_status": 1,
                    "name": "SingleHost#2",
                    "uuid_url": "shnQjAt_QBmeRjc6lYrcAQ"
                },
                {
                    "app_status": 1,
                    "name": "SingleHost#3",
                    "uuid_url": "E85_4Cq-Q4WGTkq2lT31cg"
                }
            ],
            "logging_settings": "[]",
            "pwd_comments": null,
            "data_service": true,
            "subnet": null,
            "tz": null,
            "hostname": null,
            "ram_size": null,
            "download_url": null,
            "gateway": null,
            "os_version": null,
            "state": 0,
            "agent_type": 1,
            "uuid_url": "zOFC4JBSQ3OuGReWVPcB3A",
            "policy": "bmOy5TeRRBuByVZiS0cITQ",
            "dhcp": "enabled",
            "agent_upgrade_suspended": false,
            "advanced_settings": {
                "network_info": [
                    "0.0.0.0/0"
                ]
            },
            "status": 1,
            "agent_upgrade_enabled": true,
            "description": null,
            "reach": 0,
            "debug_channel_permitted": true,
            "last_checkin": null,
            "all_directories": [
                {
                    "name": "Cloud Directory",
                    "uuid_url": "GbIfrXwtTKaqBrXD0ZkGBA"
                },
                {
                    "name": "Akamai Directory",
                    "uuid_url": "SewbYG0iRZSPaMZrM6n4Qw"
                }
            ],
            "region": null,
            "dns_server": null,
            "disk_size": null,
            "name": "tcp-tunnel",
            "package": 3,
            "created_at": "2019-05-02T09:27:11.677150",
            "modified_at": "2019-05-02T09:27:11.684264",
            "mac": null,
            "resource_uri": {
                "href": "/api/v1/agents/zOFC4JBSQ3OuGReWVPcB3A"
            },
            "cpu": null,
            "agent_version": null
        }
    ]
}

  1. Run the List applications operation and store the relevant applicationId.

  2. Ensure you have your contractId query parameter.

  3. For pagination, set offset the number of members to skip in the object list.

  4. For a pagination, set limit to specify the maximum number of members to return in the response.

  5. Make a GET request to /crux/v1/mgmt-pop/apps/{applicationId}/agents{?contractId,offset,limit}.

  6. The operation responds with an array of Application.agents objects.

Assign agents

Assign agents for an application configuration.

POST /crux/v1/mgmt-pop/apps/{applicationId}/agents{?contractId}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA/agents?contractId=F-EMGSGV

Content-Type: application/json

Download schema: agents.json

Request body:

{
    "agents": [
        {
            "compatible": true,
            "uuid_url": "a5_xNtxbR9O_c4xy35R2Wg",
            "name": "bala7-ohio-aws"
        }
    ]
}
Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: agents.json

Response body:

[
    {
        "agent": {
            "name": "bala7-ohio-aws",
            "uuid_url": "a5_xNtxbR9O_c4xy35R2Wg"
        },
        "resource_uri": {
            "href": "/api/v1/agents/a5_xNtxbR9O_c4xy35R2Wg/"
        }
    }
]

  1. Run the List applications operation and store the relevant applicationId.

  2. Ensure you have your contractId query parameter.

  3. Build a new standalone Application.agents object.

  4. POST the object to /crux/v1/mgmt-pop/apps/{applicationId}/agents{?contractId}.

  5. The operation responds with an array of Application.agents objects.

Get an agent

Returns an agent of an application configuration.

GET /crux/v1/mgmt-pop/apps/{applicationId}/agents/{agentId}{?contractId}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA/agents/D5_RrR_2TEOOYHWxo4xHpQ?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
agentId String D5_RrR_2TEOOYHWxo4xHpQ A unique identifier for each agent.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Response body:

{
    "ip_addr": null,
    "setpwd_attempt": 1,
    "auth_service": true,
    "public_ip": null,
    "pwdsyncflag": false,
    "private_ip": null,
    "manual_override": false,
    "logging_settings": "[]",
    "pwd_comments": null,
    "data_service": true,
    "subnet": null,
    "tz": null,
    "hostname": null,
    "ram_size": null,
    "download_url": null,
    "gateway": null,
    "os_version": null,
    "state": 0,
    "agent_type": 1,
    "uuid_url": "zOFC4JBSQ3OuGReWVPcB3A",
    "policy": "bmOy5TeRRBuByVZiS0cITQ",
    "dhcp": "enabled",
    "agent_upgrade_suspended": false,
    "advanced_settings": {
        "network_info": [
            "0.0.0.0/0"
        ]
    },
    "status": 1,
    "agent_upgrade_enabled": true,
    "description": null,
    "reach": 0,
    "debug_channel_permitted": true,
    "last_checkin": null,
    "mac": null,
    "region": null,
    "dns_server": null,
    "disk_size": null,
    "name": "tcp-tunnel",
    "package": 3,
    "created_at": "2019-05-02T09:27:11.677150",
    "modified_at": "2019-05-02T09:27:11.684264",
    "resource_uri": {
        "href": "/api/v1/agents/zOFC4JBSQ3OuGReWVPcB3A"
    },
    "cpu": null,
    "agent_version": null
}

  1. Run the List applications operation and store the relevant applicationId.

  2. Run the List agents operation and store the relevant agentId.

  3. Ensure you have your contractId query parameter.

  4. Make a GET request to /crux/v1/mgmt-pop/apps/{applicationId}/agents/{agentId}{?contractId}.

  5. The operation responds with an Application.agents object.

List urllocations

Returns a list of urllocations for an application configuration.

GET /crux/v1/mgmt-pop/apps/{applicationId}/urllocation{?contractId,offset,limit}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA/urllocation?contractId=F-EMGSGV&offset=10&limit=30

Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Response body:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "app_uuid_url": "3Czu34blSkarRHafL2v8bQ",
            "description": null,
            "name": "asdf",
            "resource_uri": {
                "href": "/api/v1/apps/3Czu34blSkarRHafL2v8bQ/urllocation/Erzz3LiSQqSp0uIw28aMKQ"
            },
            "servers": [
                {
                    "origin_host": "12.34.45.6",
                    "origin_port": 80,
                    "origin_protocol": "http"
                }
            ],
            "settings": {
                "anonymous_server_conn_limit": "50",
                "anonymous_server_request_limit": "100",
                "app_auth": "none",
                "app_auth_domain": null,
                "app_cookie_domain": null,
                "app_location": null,
                "app_server_read_timeout": "60",
                "authenticated_server_conn_limit": "50",
                "authenticated_server_request_limit": "100",
                "authentication_enabled": "false",
                "cookie_domain": null,
                "external_cookie_domain": null,
                "health_check_fall": "3",
                "health_check_http_host_header": null,
                "health_check_http_url": "/",
                "health_check_http_version": "1.1",
                "health_check_interval": "30000",
                "health_check_rise": "2",
                "health_check_timeout": "50000",
                "health_check_type": "0",
                "hidden_app": "false",
                "http_only_cookie": "true",
                "https_sslv3": "false",
                "idle_close_time_seconds": "1200",
                "idle_conn_ceil": "75",
                "idle_conn_floor": "50",
                "idle_conn_step": "10",
                "idp_idle_expiry": null,
                "idp_max_expiry": null,
                "ignore_cname_resolution": "false",
                "inject_ajax_javascript": "off",
                "internal_hostname": null,
                "kerberos_negotiate_once": "off",
                "load_balancing_metric": "round-robin",
                "logging_enabled": "true",
                "login_timeout": "5",
                "login_url": null,
                "logout_url": null,
                "mfa": "inherit",
                "preauth_enforce_url": "",
                "proxy_buffer_size_kb": "4",
                "proxy_disable_clipboard": "false",
                "rate_limit": "on",
                "rdp_initial_program": null,
                "refresh_sticky_cookie": "on",
                "request_body_rewrite": "false",
                "request_parameters": null,
                "saas_enabled": "false",
                "sentry_redirect_401": "off",
                "server_cert_validate": "true",
                "server_request_burst": "100",
                "service_principle_name": null,
                "session_sticky": "false",
                "session_sticky_cookie_maxage": "0",
                "session_sticky_server_cookie": null,
                "spdy_enabled": "true",
                "ssh_audit_enabled": "false",
                "sso": "true",
                "use_internal_host": "false",
                "user_name": null,
                "wapp_auth": "form",
                "websocket_enabled": "false"
            },
            "status": 1,
            "url": "/asdf",
            "uuid_url": "Erzz3LiSQqSp0uIw28aMKQ"
        }
    ]
}

  1. Run the List applications operation and store the relevant applicationId.

  2. Ensure you have your contractId query parameter.

  3. For pagination, set offset the number of members to skip in the object list.

  4. For a pagination, set limit to specify the maximum number of members to return in the response.

  5. Make a GET request to /crux/v1/mgmt-pop/apps/{applicationId}/urllocation{?contractId,offset,limit}.

Get a urllocation

Returns the URL location of an application configuration.

GET /crux/v1/mgmt-pop/apps/{applicationId}/urllocation/{locationId}{?contractId}

Sample: /crux/v1/mgmt-pop/apps/ojxkXzwyQZiBkoRee0XcnA/urllocation/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
applicationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application.
locationId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each URL location.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Response body:

{
    "app_uuid_url": "3Czu34blSkarRHafL2v8bQ",
    "description": null,
    "name": "asdf",
    "resource_uri": {
        "href": "/api/v1/apps/3Czu34blSkarRHafL2v8bQ/urllocation/Erzz3LiSQqSp0uIw28aMKQ"
    },
    "servers": [
        {
            "origin_host": "12.34.45.6",
            "origin_port": 80,
            "origin_protocol": "http"
        }
    ],
    "settings": {
        "anonymous_server_conn_limit": "50",
        "anonymous_server_request_limit": "100",
        "app_auth": "none",
        "app_auth_domain": null,
        "app_cookie_domain": null,
        "app_location": null,
        "app_server_read_timeout": "60",
        "authenticated_server_conn_limit": "50",
        "authenticated_server_request_limit": "100",
        "authentication_enabled": "false",
        "cookie_domain": null,
        "external_cookie_domain": null,
        "health_check_fall": "3",
        "health_check_http_host_header": null,
        "health_check_http_url": "/",
        "health_check_http_version": "1.1",
        "health_check_interval": "30000",
        "health_check_rise": "2",
        "health_check_timeout": "50000",
        "health_check_type": "0",
        "hidden_app": "false",
        "http_only_cookie": "true",
        "https_sslv3": "false",
        "idle_close_time_seconds": "1200",
        "idle_conn_ceil": "75",
        "idle_conn_floor": "50",
        "idle_conn_step": "10",
        "idp_idle_expiry": null,
        "idp_max_expiry": null,
        "ignore_cname_resolution": "false",
        "inject_ajax_javascript": "off",
        "internal_hostname": null,
        "kerberos_negotiate_once": "off",
        "load_balancing_metric": "round-robin",
        "logging_enabled": "true",
        "login_timeout": "5",
        "login_url": null,
        "logout_url": null,
        "mfa": "inherit",
        "preauth_enforce_url": "",
        "proxy_buffer_size_kb": "4",
        "proxy_disable_clipboard": "false",
        "rate_limit": "on",
        "rdp_initial_program": null,
        "refresh_sticky_cookie": "on",
        "request_body_rewrite": "false",
        "request_parameters": null,
        "saas_enabled": "false",
        "sentry_redirect_401": "off",
        "server_cert_validate": "true",
        "server_request_burst": "100",
        "service_principle_name": null,
        "session_sticky": "false",
        "session_sticky_cookie_maxage": "0",
        "session_sticky_server_cookie": null,
        "spdy_enabled": "true",
        "ssh_audit_enabled": "false",
        "sso": "true",
        "use_internal_host": "false",
        "user_name": null,
        "wapp_auth": "form",
        "websocket_enabled": "false"
    },
    "status": 1,
    "url": "/asdf",
    "uuid_url": "Erzz3LiSQqSp0uIw28aMKQ"
}

  1. Run the List applications operation and store the relevant applicationId.

  2. Run the List url locations operation and store the relevant locationId.

  3. Ensure you have your contractId query parameter.

  4. Make a GET request to /crux/v1/mgmt-pop/apps/{applicationId}/urllocation/{locationId}{?contractId}.

  5. The operation responds with a UrlLocation object.

List application IDPs

Lists application IDPs of the Enterprise Application Access product you have access to.

GET /crux/v1/mgmt-pop/appidp{?contractId,offset,limit,expand}

Sample: /crux/v1/mgmt-pop/appidp?contractId=F-EMGSGV&offset=10&limit=30&expand=true

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: AppIdp

Download schema: app-idps.json

Response body:

{
    "meta": {
        "limit": 5,
        "next": "?limit=5&offset=10",
        "offset": 5,
        "previous": "?limit=5&offset=0",
        "total_count": 126
    },
    "objects": [
        {
            "app": {
                "app_uuid_url": "1eujJKCSSuOEkBy5Q7hEAw",
                "name": "JIRA-SAML"
            },
            "enable_mfa": "inherit",
            "idp": {
                "idp_uuid_url": "lMEgMEgeTxKlRaaP1u5kLg",
                "name": "Company-SAML-IDP"
            },
            "resource": "appidp",
            "resource_uri": {
                "apps": "/api/v1/apps/1eujJKCSSuOEkBy5Q7hEAw",
                "href": "/api/v1/appidp/HQZpYw1nRlucFcQLvLG2yQ",
                "idp": "/api/v1/idp/lMEgMEgeTxKlRaaP1u5kLg"
            },
            "uuid_url": "HQZpYw1nRlucFcQLvLG2yQ"
        },
        {
            "app": {
                "app_uuid_url": "Dtt5_YNQRmGpa75yWMrBxg",
                "name": "Salesforce"
            },
            "enable_mfa": "inherit",
            "idp": {
                "idp_uuid_url": "fsGXD1aYQyCPjqi48kK6nQ",
                "name": "Company-SALM-IDP"
            },
            "resource": "appidp",
            "resource_uri": {
                "apps": "/api/v1/apps/Dtt5_YNQRmGpa75yWMrBxg",
                "href": "/api/v1/appidp/CVxouRl2RlCLUFuMylSg8g",
                "idp": "/api/v1/idp/fsGXD1aYQyCPjqi48kK6nQ"
            },
            "uuid_url": "CVxouRl2RlCLUFuMylSg8g"
        },
        {
            "app": {
                "app_uuid_url": "2Cra4G6CR4SqqzwOJCTxlA",
                "name": "Jenkins"
            },
            "enable_mfa": "inherit",
            "idp": {
                "idp_uuid_url": "fsGXD1aYQyCPjqi48kK6nQ",
                "name": "Company-SALM-IDP"
            },
            "resource": "appidp",
            "resource_uri": {
                "apps": "/api/v1/apps/2Cra4G6CR4SqqzwOJCTxlA",
                "href": "/api/v1/appidp/-UGGcAyWR1CTPyLLh_7BoQ",
                "idp": "/api/v1/idp/fsGXD1aYQyCPjqi48kK6nQ"
            },
            "uuid_url": "-UGGcAyWR1CTPyLLh_7BoQ"
        },
        {
            "app": {
                "app_uuid_url": "3UjG8gGwT828Tm6ub0zVcA",
                "name": "Windows-RDP"
            },
            "enable_mfa": "inherit",
            "idp": {
                "idp_uuid_url": "fsGXD1aYQyCPjqi48kK6nQ",
                "name": "SecPerimeter-SALM-IDP"
            },
            "resource": "appidp",
            "resource_uri": {
                "apps": "/api/v1/apps/3UjG8gGwT828Tm6ub0zVcA",
                "href": "/api/v1/appidp/trvuYZqqRYm6_t-7TRY_5A",
                "idp": "/api/v1/idp/fsGXD1aYQyCPjqi48kK6nQ"
            },
            "uuid_url": "trvuYZqqRYm6_t-7TRY_5A"
        },
        {
            "app": {
                "app_uuid_url": "vgn_sEBdQ6arcR-D4tZW1Q",
                "name": "This Company HTTP App"
            },
            "enable_mfa": "inherit",
            "idp": {
                "idp_uuid_url": "fsGXD1aYQyCPjqi48kK6nQ",
                "name": "Company-SALM-IDP"
            },
            "resource": "appidp",
            "resource_uri": {
                "apps": "/api/v1/apps/vgn_sEBdQ6arcR-D4tZW1Q",
                "href": "/api/v1/appidp/JCOqMBfWTR-M_kXcd8y1Cg",
                "idp": "/api/v1/idp/fsGXD1aYQyCPjqi48kK6nQ"
            },
            "uuid_url": "JCOqMBfWTR-M_kXcd8y1Cg"
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. For pagination, set offset the number of members to skip in the object list.

  3. For a pagination, set limit to specify the maximum number of members to return in the response.

  4. Optionally, set expand to true to include additional members in the response.

  5. Make a GET request to /crux/v1/mgmt-pop/appidp{?contractId,offset,limit,expand}.

  6. The operation responds with an array of AppIdp objects.

Create an application IDP

Create a new Application IDP.

POST /crux/v1/mgmt-pop/appidp{?contractId}

Sample: /crux/v1/mgmt-pop/appidp?contractId=F-EMGSGV

Content-Type: application/json

Download schema: app-idp-create.json

Request body:

{
    "app": "kTiWFtM0QtOPGT6rtAT2cw",
    "idp": "r03ZZ6AcRReHa-Nn2BHSIw"
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: AppIdp

Download schema: app-idp.json

Response body:

{
    "app": {
        "app_uuid_url": "Dtt5_YNQRmGpa75yWMrBxg",
        "name": "Salesforce-QA"
    },
    "enable_mfa": "inherit",
    "idp": {
        "idp_uuid_url": "fsGXD1aYQyCPjqi48kK6nQ",
        "name": "SecPerimeter-SALM-IDP"
    },
    "resource": "appidp",
    "resource_uri": {
        "apps": "/api/v1/apps/Dtt5_YNQRmGpa75yWMrBxg",
        "href": "/api/v1/appidp/CVxouRl2RlCLUFuMylSg8g",
        "idp": "/api/v1/idp/fsGXD1aYQyCPjqi48kK6nQ"
    },
    "uuid_url": "CVxouRl2RlCLUFuMylSg8g"
}

  1. Ensure you have your contractId query parameter.

  2. Build a new AppIdp object.

  3. POST the object to /crux/v1/mgmt-pop/appidp{?contractId}.

  4. The operation responds with an AppIdp object.

Get an application IDP

Get details for a specific application IDP.

GET /crux/v1/mgmt-pop/appidp/{appIdpId}{?contractId,expand}

Sample: /crux/v1/mgmt-pop/appidp/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV&expand=true

Parameter Type Sample Description
URL path parameters
appIdpId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application IDP.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.

Status 200 application/json

Object type: AppIdp

Download schema: app-idp.json

Response body:

{
    "app": {
        "app_uuid_url": "Dtt5_YNQRmGpa75yWMrBxg",
        "name": "Salesforce-QA"
    },
    "enable_mfa": "inherit",
    "idp": {
        "idp_uuid_url": "fsGXD1aYQyCPjqi48kK6nQ",
        "name": "SecPerimeter-SALM-IDP"
    },
    "resource": "appidp",
    "resource_uri": {
        "apps": "/api/v1/apps/Dtt5_YNQRmGpa75yWMrBxg",
        "href": "/api/v1/appidp/CVxouRl2RlCLUFuMylSg8g",
        "idp": "/api/v1/idp/fsGXD1aYQyCPjqi48kK6nQ"
    },
    "uuid_url": "CVxouRl2RlCLUFuMylSg8g"
}

  1. Run the List application IDPs and store the relevant appIdpId.

  2. Ensure you have your contractId query parameter.

  3. Optionally, set expand to true to include additional members in the response. query parameter.

  4. Make a GET request to /crux/v1/mgmt-pop/appidp/{appIdpId}{?contractId,expand}.

Delete an application IDP

Remove an Application IDP from your Enterprise Application Access product.

DELETE /crux/v1/mgmt-pop/appidp/{appIdpId}{?contractId}

Sample: /crux/v1/mgmt-pop/appidp/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
appIdpId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application IDP.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Run the List application IDPs operation and store the relevant appIdpId.

  2. Ensure you have your contractId query parameter.

  3. Make a DELETE request to /crux/v1/mgmt-pop/appidp/{appIdpId}{?contractId}.

List application bundles

Lists application bundles of the Enterprise Application Access product you have access to.

GET /crux/v1/mgmt-pop/appbundle{?contractId,offset,limit,expand}

Sample: /crux/v1/mgmt-pop/appbundle?contractId=F-EMGSGV&offset=10&limit=30&expand=true

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: AppBundle

Download schema: app-bundles.json

Response body:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 12
    },
    "objects": [
        {
            "app_details": [
                {
                    "app_deployed": true,
                    "app_operational": 3,
                    "app_profile": 1,
                    "app_status": 4,
                    "name": "",
                    "uuid_url": "8rwIWzWuSt-2dnGJ3rbqQA"
                },
                {
                    "app_deployed": true,
                    "app_operational": 3,
                    "app_profile": 1,
                    "app_status": 2,
                    "name": "MS-Office-365",
                    "uuid_url": "A92i-3VZRd23SCnL7mno8A"
                }
            ],
            "created_at": "2017-11-16T22:32:10.602218",
            "description": "Application Group 1",
            "group_apps": [
                "8rwIWzWuSt-2dnGJ3rbqQA",
                "A92i-3VZRd23SCnL7mno8A"
            ],
            "modified_at": "2017-12-04T19:33:32.427605",
            "name": "Group 1",
            "resource_uri": {
                "href": "/api/v1/appbundle/xjfw56YkTiWLRC4HL9Ycbg"
            },
            "status": 1,
            "uuid_url": "xjfw56YkTiWLRC4HL9Ycbg"
        },
        {
            "app_details": [
                {
                    "app_deployed": false,
                    "app_operational": 3,
                    "app_profile": 1,
                    "app_status": 1,
                    "app_type": 1,
                    "name": "Custom  IDP change",
                    "single_host_content_rw": false,
                    "single_host_path": "",
                    "uuid_url": "Ht-jz4FJRg2D13m7DfCZ5Q"
                }
            ],
            "created_at": "2021-05-25T15:22:59.221288",
            "description": "TEST Application group",
            "group_apps": [
                "Ht-jz4FJRg2D13m7DfCZ5Q"
            ],
            "modified_at": "2021-05-25T15:25:38.434715",
            "name": "TEST_GROUP",
            "resource_uri": {
                "href": "/api/v1/appbundle/LmWWytH-TMutd6P9G0Ts7A"
            },
            "single_host_enable": false,
            "single_host_fqdn": "",
            "status": 1,
            "uuid_url": "LmWWytH-TMutd6P9G0Ts7A"
        },
        {
            "app_details": [],
            "created_at": "2017-12-04T19:40:39.229643",
            "description": "Application Group 2",
            "group_apps": [],
            "modified_at": "2017-12-18T19:51:29.412656",
            "name": "Group 2",
            "resource_uri": {
                "href": "/api/v1/appbundle/ZpiYQhB9Q-Gx7j8E1esDvQ"
            },
            "status": 1,
            "uuid_url": "ZpiYQhB9Q-Gx7j8E1esDvQ"
        },
        {
            "app_details": [
                {
                    "app_deployed": true,
                    "app_operational": 3,
                    "app_profile": 2,
                    "app_status": 2,
                    "name": "Sharepoint",
                    "uuid_url": "c56UQEqdQWSPrVplsgf9HQ"
                },
                {
                    "app_deployed": true,
                    "app_operational": 3,
                    "app_profile": 1,
                    "app_status": 2,
                    "name": "OIDC SaaS Application",
                    "uuid_url": "SqCl6yLmStukGGQgiNAJ9g"
                },
                {
                    "app_deployed": true,
                    "app_operational": 3,
                    "app_profile": 2,
                    "app_status": 2,
                    "name": "SAML Access App With IWA",
                    "uuid_url": "khB0vkY3TAqxmXTozSeD4g"
                }
            ],
            "created_at": "2017-11-16T19:52:37.634056",
            "description": "Application Group 3",
            "group_apps": [
                "c56UQEqdQWSPrVplsgf9HQ",
                "SqCl6yLmStukGGQgiNAJ9g",
                "khB0vkY3TAqxmXTozSeD4g",
                "2YsTuFU_RwqwdB3xAtsOmA",
                "CVdEiBk7SXWdGX_3BItTbQ"
            ],
            "modified_at": "2019-04-22T04:19:00.736764",
            "name": "Group 3",
            "resource_uri": {
                "href": "/api/v1/appbundle/4qypxXEAT8e8ArUy7rYjNw"
            },
            "status": 1,
            "uuid_url": "4qypxXEAT8e8ArUy7rYjNw"
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. For pagination, set offset the number of members to skip in the object list.

  3. For a pagination, set limit to specify the maximum number of members to return in the response.

  4. Optionally, set expand to true to include additional members in the response.

  5. Make a GET request to /crux/v1/mgmt-pop/appbundle{?contractId,offset,limit,expand}.

  6. The operation responds with a list of AppBundle objects.

Create an application bundle

Creates a new application bundle.

POST /crux/v1/mgmt-pop/appbundle{?contractId}

Sample: /crux/v1/mgmt-pop/appbundle?contractId=F-EMGSGV

Content-Type: application/json

Object type: AppBundle

Download schema: app-bundle.json

Request body:

{
    "name": "TEST_GROUP",
    "description": "TEST Application group"
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: AppBundle

Download schema: app-bundle.json

Response body:

{
    "app_details": [
        {
            "app_deployed": false,
            "app_operational": 3,
            "app_profile": 1,
            "app_status": 1,
            "app_type": 1,
            "name": "Custom  IDP change",
            "single_host_content_rw": false,
            "single_host_path": "",
            "uuid_url": "Ht-jz4FJRg2D13m7DfCZ5Q"
        }
    ],
    "created_at": "2021-05-25T15:22:59.221288",
    "description": "TEST Application group",
    "group_apps": [
        "Ht-jz4FJRg2D13m7DfCZ5Q"
    ],
    "modified_at": "2021-05-25T15:25:38.434715",
    "name": "TEST_GROUP",
    "resource_uri": {
        "href": "/api/v1/appbundle/LmWWytH-TMutd6P9G0Ts7A"
    },
    "single_host_enable": false,
    "single_host_fqdn": "",
    "status": 1,
    "uuid_url": "LmWWytH-TMutd6P9G0Ts7A"
}

  1. Ensure you have your contractId query parameter.

  2. Build a new AppBundle object.

  3. POST the object to /crux/v1/mgmt-pop/appbundle{?contractId}.

  4. The operation responds with a AppBundle object.

Get an application bundle

Returns details for a specific application bundle by ID.

GET /crux/v1/mgmt-pop/appbundle/{appBundleId}{?contractId,expand}

Sample: /crux/v1/mgmt-pop/appbundle/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV&expand=true

Parameter Type Sample Description
URL path parameters
appBundleId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application bundle.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.

Status 200 application/json

Object type: AppBundle

Download schema: app-bundle.json

Response body:

{
    "app_details": [
        {
            "app_deployed": false,
            "app_operational": 3,
            "app_profile": 1,
            "app_status": 1,
            "app_type": 1,
            "name": "Custom  IDP change",
            "single_host_content_rw": false,
            "single_host_path": "",
            "uuid_url": "Ht-jz4FJRg2D13m7DfCZ5Q"
        }
    ],
    "created_at": "2021-05-25T15:22:59.221288",
    "description": "TEST Application group",
    "group_apps": [
        "Ht-jz4FJRg2D13m7DfCZ5Q"
    ],
    "modified_at": "2021-05-25T15:25:38.434715",
    "name": "TEST_GROUP",
    "resource_uri": {
        "href": "/api/v1/appbundle/LmWWytH-TMutd6P9G0Ts7A"
    },
    "single_host_enable": false,
    "single_host_fqdn": "",
    "status": 1,
    "uuid_url": "LmWWytH-TMutd6P9G0Ts7A"
}

  1. Ensure you have your contractId query parameter.

  2. Run the List application bundles operation and store the relevant appBundleId.

  3. Optionally, set expand to true to include additional members in the response.

  4. Make a GET request to /crux/v1/mgmt-pop/appbundle/{appBundleId}{?contractId,expand}.

  5. The operation responds with a AppBundle object.

Modify an application bundle

Modifies an existing application bundle.

PUT /crux/v1/mgmt-pop/appbundle/{appBundleId}{?contractId}

Sample: /crux/v1/mgmt-pop/appbundle/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Content-Type: application/json

Object type: AppBundle

Download schema: app-bundle.json

Request body:

{
    "app_details": [
        {
            "app_deployed": false,
            "app_operational": 3,
            "app_profile": 1,
            "app_status": 1,
            "app_type": 1,
            "name": "Custom  IDP change",
            "single_host_content_rw": false,
            "single_host_path": "",
            "uuid_url": "Ht-jz4FJRg2D13m7DfCZ5Q"
        }
    ],
    "created_at": "2021-05-25T15:22:59.221288",
    "description": "TEST Application group",
    "group_apps": [
        "Ht-jz4FJRg2D13m7DfCZ5Q"
    ],
    "modified_at": "2021-05-25T15:25:38.434715",
    "name": "TEST_GROUP",
    "single_host_enable": false,
    "single_host_fqdn": "",
    "status": 1
}
Parameter Type Sample Description
URL path parameters
appBundleId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application bundle.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: AppBundle

Download schema: app-bundle.json

Response body:

{
    "app_details": [
        {
            "app_deployed": false,
            "app_operational": 3,
            "app_profile": 1,
            "app_status": 1,
            "app_type": 1,
            "name": "Custom  IDP change",
            "single_host_content_rw": false,
            "single_host_path": "",
            "uuid_url": "Ht-jz4FJRg2D13m7DfCZ5Q"
        }
    ],
    "created_at": "2021-05-25T15:22:59.221288",
    "description": "TEST Application group",
    "group_apps": [
        "Ht-jz4FJRg2D13m7DfCZ5Q"
    ],
    "modified_at": "2021-05-25T15:25:38.434715",
    "name": "TEST_GROUP",
    "resource_uri": {
        "href": "/api/v1/appbundle/LmWWytH-TMutd6P9G0Ts7A"
    },
    "single_host_enable": false,
    "single_host_fqdn": "",
    "status": 1,
    "uuid_url": "LmWWytH-TMutd6P9G0Ts7A"
}

  1. Ensure you have your contractId query parameter.

  2. Run the List application bundles operation and store the relevant appBundleId.

  3. Run the Get an application bundle operation and store the response object.

  4. Modify the AppBundle object.

  5. PUT the object to /crux/v1/mgmt-pop/appbundle/{appBundleId}{?contractId}.

  6. The operation responds with a AppBundle object.

Delete an application bundle

Removes an application bundle.

DELETE /crux/v1/mgmt-pop/appbundle/{appBundleId}{?contractId}

Sample: /crux/v1/mgmt-pop/appbundle/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
appBundleId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application bundle.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

Deploy an application bundle

Deploys the specified application bundle.

POST /crux/v1/mgmt-pop/appbundle/{appBundleId}/deploy{?contractId}

Sample: /crux/v1/mgmt-pop/appbundle/ojxkXzwyQZiBkoRee0XcnA/deploy?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
appBundleId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application bundle.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: deploy-app-bundle.json

Response body:

[
    {
        "cmdid": 9564781812219316,
        "app_id": "YqQlGzjYRzuSX04c8CECtw"
    },
    {
        "cmdid": 4371139853414614,
        "app_id": "9m6LGDHhTWubkb4gU6O9NA"
    },
    {
        "cmdid": 5651681481824975,
        "app_id": "rNWsDCSSQGSUn9gNHQ89NQ"
    }
]

  1. Ensure you have your contractId query parameter.

  2. Run the List application bundles operation and store the relevant appBundleId.

  3. Make a POST request to /crux/v1/mgmt-pop/appbundle/{appBundleId}/deploy{?contractId}.

  4. The operation responds with a CommandId object.

List application categories

Lists application categories for the Enterprise Application Access product you have access to.

GET /crux/v1/mgmt-pop/appcategories{?contractId,offset,limit,expand}

Sample: /crux/v1/mgmt-pop/appcategories?contractId=F-EMGSGV&offset=10&limit=30&expand=true

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: AppCategory

Download schema: app-categories.json

Response body:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 3
    },
    "objects": [
        {
            "app_details": [
                {
                    "name": "Employee OIDC.Net Hybrid",
                    "uuid_url": "IzlikGM3QQ6EvXZyeG1haw"
                },
                {
                    "name": "EAAClient One Domain",
                    "uuid_url": "M8VAuzP6Sz-ATdQPEkfO4g"
                }
            ],
            "color_hex_code": "#2d70e8",
            "created_at": "2018-08-07T14:14:33.660117",
            "description": "Communication Applications",
            "modified_at": "2018-08-07T14:18:37.543968",
            "name": "Communications",
            "resource_uri": "/api/v1/appcategories/04c6bb16-0a69-4856-a6d8-67ec8d9c34dd",
            "uuid_url": "BMa7FgppSFam2GfsjZw03Q"
        },
        {
            "app_details": [
                {
                    "name": "SecPerimeter Sharepoint",
                    "uuid_url": "IzlikGM3QQ6EvXZyeG1haw"
                }
            ],
            "color_hex_code": "#2d70e8",
            "created_at": "2017-11-01T17:23:28.220874",
            "description": null,
            "modified_at": "2017-11-01T17:23:44.492034",
            "name": "Kerberos",
            "resource_uri": "/api/v1/appcategories/06df0b69-cce8-4cdb-83bf-0dcf2d8e2ac0",
            "uuid_url": "Bt8LaczoTNuDvw3PLY4qwA"
        },
        {
            "app_details": [
                {
                    "name": "Office365",
                    "uuid_url": "A92i-3VZRd23SCnL7mno8A"
                }
            ],
            "color_hex_code": "#5e36d0",
            "created_at": "2017-11-01T17:23:28.220874",
            "description": null,
            "modified_at": "2017-11-01T17:23:44.492034",
            "name": "SAML SaaS",
            "resource_uri": "/api/v1/appcategories/8b3de00a-c382-4bbe-b0aa-101ef32ee93e",
            "uuid_url": "iz3gCsOCS76wqhAe8y7pPg"
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. For pagination, set offset the number of members to skip in the object list.

  3. For a pagination, set limit to specify the maximum number of members to return in the response.

  4. Optionally, set expand to true to include additional members in the response.

  5. Make a GET request to /crux/v1/mgmt-pop/appcategories{?contractId,offset,limit,expand}.

  6. The operation responds with a list of AppCategory objects.

Create an application category

Create a new application category.

POST /crux/v1/mgmt-pop/appcategories{?contractId}

Sample: /crux/v1/mgmt-pop/appcategories?contractId=F-EMGSGV

Content-Type: application/json

Object type: AppCategory

Download schema: app-categories.json

Request body:

{
    "name": "TEST category",
    "description": "This is a test category"
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: AppCategory

Download schema: app-categories.json

Response body:

{
    "app_details": [],
    "color_hex_code": null,
    "created_at": "2021-05-25T15:40:47.920319",
    "description": "This is a test category",
    "modified_at": "2021-05-25T15:40:47.920330",
    "name": "TEST category",
    "resource_uri": "/api/v1/appcategories/d01cd4a2-efb7-47ae-9d7d-5f0ea6899c4b",
    "uuid_url": "iNSex9QrQnCljLXHk5FHbQ"
}

  1. Ensure you have your contractId query parameter.

  2. Build a new AppCategory object.

  3. POST the object to /crux/v1/mgmt-pop/appcategories{?contractId}.

  4. The operation responds with a AppCategory object.

Get an application category

Returns details for a specific application category.

GET /crux/v1/mgmt-pop/appcategories/{appCategoryId}{?contractId,expand}

Sample: /crux/v1/mgmt-pop/appcategories/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV&expand=true

Parameter Type Sample Description
URL path parameters
appCategoryId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application category.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.

Status 200 application/json

Object type: AppCategory

Download schema: app-categories.json

Response body:

{
    "app_details": [],
    "color_hex_code": null,
    "created_at": "2021-05-25T15:40:47.920319",
    "description": "This is a test category",
    "modified_at": "2021-05-25T15:40:47.920330",
    "name": "TEST category",
    "resource_uri": "/api/v1/appcategories/d01cd4a2-efb7-47ae-9d7d-5f0ea6899c4b",
    "uuid_url": "iNSex9QrQnCljLXHk5FHbQ"
}

  1. Ensure you have your contractId query parameter.

  2. Run the List application categories operation and store the relevant appCategoryId.

  3. Optionally, set expand to true to include additional members in the response.

  4. Make a GET request to /crux/v1/mgmt-pop/appcategories/{appCategoryId}{?contractId,expand}.

  5. The operation responds with a AppCategory object.

Modify an application category

Modifies an existing application category.

PUT /crux/v1/mgmt-pop/appcategories/{appCategoryId}{?contractId}

Sample: /crux/v1/mgmt-pop/appcategories/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Content-Type: application/json

Object type: AppCategory

Download schema: app-categories.json

Request body:

{
    "app_details": [
        {
            "name": "Test custom http app",
            "uuid_url": "F1X8BT5WSq2wLeccDYe7BA"
        }
    ],
    "color_hex_code": "#6ba5bd",
    "created_at": "2021-05-25T15:40:47.920319",
    "description": "This is a test category",
    "modified_at": "2021-05-25T15:49:08.489470",
    "name": "TEST category"
}
Parameter Type Sample Description
URL path parameters
appCategoryId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application category.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: AppCategory

Download schema: app-categories.json

Response body:

{
    "app_details": [],
    "color_hex_code": null,
    "created_at": "2021-05-25T15:40:47.920319",
    "description": "This is a test category",
    "modified_at": "2021-05-25T15:40:47.920330",
    "name": "TEST category",
    "resource_uri": "/api/v1/appcategories/d01cd4a2-efb7-47ae-9d7d-5f0ea6899c4b",
    "uuid_url": "iNSex9QrQnCljLXHk5FHbQ"
}

  1. Ensure you have your contractId query parameter.

  2. Run the List application categories operation and store the relevant appCategoryId.

  3. Run the Get an application category operation and store the response object.

  4. Modify the AppCategory object.

  5. PUT the object to /crux/v1/mgmt-pop/appcategories/{appCategoryId}{?contractId}.

  6. The operation responds with a AppCategory object.

Delete an application category

Removes an application category from your Enterprise Application Access product.

DELETE /crux/v1/mgmt-pop/appcategories/{appCategoryId}{?contractId}

Sample: /crux/v1/mgmt-pop/appcategories/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
appCategoryId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application category.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

List application directories

Lists all application directories you have access to.

GET /crux/v1/mgmt-pop/appdirectories{?contractId,offset,limit,expand}

Sample: /crux/v1/mgmt-pop/appdirectories?contractId=F-EMGSGV&offset=10&limit=30&expand=true

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: AppDirectory

Download schema: app-directories.json

Response body:

{
    "meta": {
        "limit": 20,
        "next": "?limit=20&offset=20",
        "offset": 0,
        "previous": null,
        "total_count": 209
    },
    "objects": [
        {
            "app": {
                "app_uuid_url": "n4o8-XC2QUq6WMbDjjpl7w",
                "name": "SaaS App"
            },
            "directory": {
                "directory_uuid_url": "DMzkC7IvTkiLiRN6cGWxMw",
                "name": "Cloud Directory"
            },
            "enable_mfa": "inherit",
            "resource": "appdirectories",
            "resource_uri": {
                "apps": "/api/v1/apps/n4o8-XC2QUq6WMbDjjpl7w",
                "directories": "/api/v1/directories/DMzkC7IvTkiLiRN6cGWxMw",
                "href": "/api/v1/appdirectories/flaeNl3wRfmjzvUBUVJsgw"
            },
            "uuid_url": "flaeNl3wRfmjzvUBUVJsgw"
        },
        {
            "app": {
                "app_uuid_url": "n4o8-XC2QUq6WMbDjjpl7w",
                "name": "SaaS App"
            },
            "directory": {
                "directory_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "name": "Internal"
            },
            "enable_mfa": "inherit",
            "resource": "appdirectories",
            "resource_uri": {
                "apps": "/api/v1/apps/n4o8-XC2QUq6WMbDjjpl7w",
                "directories": "/api/v1/directories/z2WI-DS9RAKWj4ecsYI3BA",
                "href": "/api/v1/appdirectories/oBpcyS2wQW-0G6o16b57jQ"
            },
            "uuid_url": "oBpcyS2wQW-0G6o16b57jQ"
        },
        {
            "app": {
                "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
                "name": "Saleforce"
            },
            "directory": {
                "directory_uuid_url": "Lg8-p9gfRh-xYly5WAdvFw",
                "name": "San Jose"
            },
            "enable_mfa": "inherit",
            "resource": "appdirectories",
            "resource_uri": {
                "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
                "directories": "/api/v1/directories/Lg8-p9gfRh-xYly5WAdvFw",
                "href": "/api/v1/appdirectories/owbUXDF8Rzqvwv5xKYlTgg"
            },
            "uuid_url": "owbUXDF8Rzqvwv5xKYlTgg"
        },
        {
            "app": {
                "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
                "name": "Saleforce"
            },
            "directory": {
                "directory_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "name": "Cloud Directory"
            },
            "enable_mfa": "inherit",
            "resource": "appdirectories",
            "resource_uri": {
                "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
                "directories": "/api/v1/directories/z2WI-DS9RAKWj4ecsYI3BA",
                "href": "/api/v1/appdirectories/xf2rrRJZTNae1-cwULygpg"
            },
            "uuid_url": "xf2rrRJZTNae1-cwULygpg"
        },
        {
            "app": {
                "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
                "name": "Saleforce"
            },
            "directory": {
                "directory_uuid_url": "DMzkC7IvTkiLiRN6cGWxMw",
                "name": "New York"
            },
            "enable_mfa": "inherit",
            "resource": "appdirectories",
            "resource_uri": {
                "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
                "directories": "/api/v1/directories/DMzkC7IvTkiLiRN6cGWxMw",
                "href": "/api/v1/appdirectories/2Xq3HJhKS9Ke4_BVH57i-Q"
            },
            "uuid_url": "2Xq3HJhKS9Ke4_BVH57i-Q"
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. For pagination, set offset the number of members to skip in the object list.

  3. For a pagination, set limit to specify the maximum number of members to return in the response.

  4. Optionally, set expand to true to include additional members in the response.

  5. Make a GET request to /crux/v1/mgmt-pop/appdirectories{?contractId,offset,limit,expand}.

  6. The operation responds with an array of AppDirectory objects.

Create or delete application directories

Creates or deletes a set of application and directories.

POST /crux/v1/mgmt-pop/appdirectories{?contractId,method}

Sample: /crux/v1/mgmt-pop/appdirectories?contractId=F-EMGSGV&method=DELETE

Content-Type: application/json

Download schema: app-directory-create.json

Request body:

{
    "data": [
        {
            "apps": [
                "3JEFvcNxRKCoQk-al9PAZw"
            ],
            "directories": [
                {
                    "uuid_url": "gKP_FhvmSFaomjpNaR7Z9Q",
                    "enable_mfa": null
                }
            ]
        }
    ]
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
method String DELETE Set this query parameter to DELETE for a POST request when you want the resource removed.

Status 200 application/json

Object type: AppDirectory

Download schema: app-directory.json

Response body:

{
    "app": {
        "app_uuid_url": "n4o8-XC2QUq6WMbDjjpl7w",
        "name": "SaaS App"
    },
    "directory": {
        "directory_uuid_url": "DMzkC7IvTkiLiRN6cGWxMw",
        "name": "Cloud Directory"
    },
    "enable_mfa": "inherit",
    "resource": "appdirectories",
    "resource_uri": {
        "apps": "/api/v1/apps/n4o8-XC2QUq6WMbDjjpl7w",
        "directories": "/api/v1/directories/DMzkC7IvTkiLiRN6cGWxMw",
        "href": "/api/v1/appdirectories/flaeNl3wRfmjzvUBUVJsgw"
    },
    "uuid_url": "flaeNl3wRfmjzvUBUVJsgw"
}

  1. Ensure you have your contractId query parameter.

  2. Optionally, to delete the application directory, set method to delete.

  3. Build a new AppDirectory object if you are creating something new.

  4. POST the object to /crux/v1/mgmt-pop/appdirectories{?contractId,method}.

  5. The operation responds with an AppDirectory object.

Get an application directory

Get details for a specific application directory.

GET /crux/v1/mgmt-pop/appdirectories/{appDirectoryId}{?contractId,expand}

Sample: /crux/v1/mgmt-pop/appdirectories/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV&expand=true

Parameter Type Sample Description
URL path parameters
appDirectoryId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.

Status 200 application/json

Object type: AppDirectory

Download schema: app-directory.json

Response body:

{
    "app": {
        "app_uuid_url": "n4o8-XC2QUq6WMbDjjpl7w",
        "name": "SaaS App"
    },
    "directory": {
        "directory_uuid_url": "DMzkC7IvTkiLiRN6cGWxMw",
        "name": "Cloud Directory"
    },
    "enable_mfa": "inherit",
    "resource": "appdirectories",
    "resource_uri": {
        "apps": "/api/v1/apps/n4o8-XC2QUq6WMbDjjpl7w",
        "directories": "/api/v1/directories/DMzkC7IvTkiLiRN6cGWxMw",
        "href": "/api/v1/appdirectories/flaeNl3wRfmjzvUBUVJsgw"
    },
    "uuid_url": "flaeNl3wRfmjzvUBUVJsgw"
}

  1. Run the List application directories operation and store the relevant appDirectoryId.

  2. Ensure you have your contractId query parameter.

  3. Optionally, set expand to true to include additional members in the response.

  4. Make a GET request to /crux/v1/mgmt-pop/appdirectories/{appDirectoryId}{?contractId,expand}.

  5. The operation responds with an AppDirectory object.

List application groups

Lists application groups of the Enterprise Application Access product you have access to.

GET /crux/v1/mgmt-pop/appgroups{?contractId,offset,limit,expand}

Sample: /crux/v1/mgmt-pop/appgroups?contractId=F-EMGSGV&offset=10&limit=30&expand=true

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: AppGroup

Download schema: app-groups.json

Response body:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1491
    },
    "objects": [
        {
            "app": {
                "app_uuid_url": "n4o8-XC2QUq6WMbDjjpl7w",
                "name": "TestSaaSApp1"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Cloud Directory",
                "dir_uuid_url": "DMzkC7IvTkiLiRN6cGWxMw",
                "group_uuid_url": "aITPkYE1QRipnk5S4TOT1w",
                "name": "Admins"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/n4o8-XC2QUq6WMbDjjpl7w",
                "groups": "/api/v1/groups/aITPkYE1QRipnk5S4TOT1w",
                "href": "/api/v1/appgroups/1tLd5eKaQd-v14FEeSDEqA"
            },
            "uuid_url": "1tLd5eKaQd-v14FEeSDEqA"
        },
        {
            "app": {
                "app_uuid_url": "n4o8-XC2QUq6WMbDjjpl7w",
                "name": "TestSaaSApp1"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Cloud Directory",
                "dir_uuid_url": "DMzkC7IvTkiLiRN6cGWxMw",
                "group_uuid_url": "rHB7BUZXSvab74JrFFcT7A",
                "name": "Users"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/n4o8-XC2QUq6WMbDjjpl7w",
                "groups": "/api/v1/groups/rHB7BUZXSvab74JrFFcT7A",
                "href": "/api/v1/appgroups/ZlB8MTbXRl6ck5DHGiJYvw"
            },
            "uuid_url": "ZlB8MTbXRl6ck5DHGiJYvw"
        },
        {
            "app": {
                "app_uuid_url": "n4o8-XC2QUq6WMbDjjpl7w",
                "name": "TestSaaSApp1"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "wyvJl9UcRt2M0LW1U9j2WA",
                "name": "WebGroup"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/n4o8-XC2QUq6WMbDjjpl7w",
                "groups": "/api/v1/groups/wyvJl9UcRt2M0LW1U9j2WA",
                "href": "/api/v1/appgroups/jWbz3S7QQRGJPcHwAli49Q"
            },
            "uuid_url": "jWbz3S7QQRGJPcHwAli49Q"
        },
        {
            "app": {
                "app_uuid_url": "n4o8-XC2QUq6WMbDjjpl7w",
                "name": "TestSaaSApp1"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "Xged4sjbTe-wzz57P_S_sA",
                "name": "RDPGroup"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/n4o8-XC2QUq6WMbDjjpl7w",
                "groups": "/api/v1/groups/Xged4sjbTe-wzz57P_S_sA",
                "href": "/api/v1/appgroups/LunoXzdrTTmke7QWVLLr2A"
            },
            "uuid_url": "LunoXzdrTTmke7QWVLLr2A"
        },
        {
            "app": {
                "app_uuid_url": "n4o8-XC2QUq6WMbDjjpl7w",
                "name": "TestSaaSApp1"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "xovNEzLaQVibmAj2mOD5DA",
                "name": "Soha Employees"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/n4o8-XC2QUq6WMbDjjpl7w",
                "groups": "/api/v1/groups/xovNEzLaQVibmAj2mOD5DA",
                "href": "/api/v1/appgroups/tlqo4hwxTd6wfeM7H3L6Mg"
            },
            "uuid_url": "tlqo4hwxTd6wfeM7H3L6Mg"
        },
        {
            "app": {
                "app_uuid_url": "n4o8-XC2QUq6WMbDjjpl7w",
                "name": "TestSaaSApp1"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "RQjOUs-uTSihyEm1mpSYNg",
                "name": "Domain Users"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/n4o8-XC2QUq6WMbDjjpl7w",
                "groups": "/api/v1/groups/RQjOUs-uTSihyEm1mpSYNg",
                "href": "/api/v1/appgroups/fB_ojXp9Q9msAMxQJZNGoQ"
            },
            "uuid_url": "fB_ojXp9Q9msAMxQJZNGoQ"
        },
        {
            "app": {
                "app_uuid_url": "9m6LGDHhTWubkb4gU6O9NA",
                "name": "TestSaaSApp2"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Cloud Directory",
                "dir_uuid_url": "DMzkC7IvTkiLiRN6cGWxMw",
                "group_uuid_url": "rHB7BUZXSvab74JrFFcT7A",
                "name": "Users"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/9m6LGDHhTWubkb4gU6O9NA",
                "groups": "/api/v1/groups/rHB7BUZXSvab74JrFFcT7A",
                "href": "/api/v1/appgroups/y9V7zDCmRkSevYTvwWgoRg"
            },
            "uuid_url": "y9V7zDCmRkSevYTvwWgoRg"
        },
        {
            "app": {
                "app_uuid_url": "9m6LGDHhTWubkb4gU6O9NA",
                "name": "TestSaaSApp2"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "Xged4sjbTe-wzz57P_S_sA",
                "name": "RDPGroup"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/9m6LGDHhTWubkb4gU6O9NA",
                "groups": "/api/v1/groups/Xged4sjbTe-wzz57P_S_sA",
                "href": "/api/v1/appgroups/m0HB-IHdTk6mqdvK1CCf2g"
            },
            "uuid_url": "m0HB-IHdTk6mqdvK1CCf2g"
        },
        {
            "app": {
                "app_uuid_url": "9m6LGDHhTWubkb4gU6O9NA",
                "name": "TestSaaSApp2"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "RQjOUs-uTSihyEm1mpSYNg",
                "name": "Domain Users"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/9m6LGDHhTWubkb4gU6O9NA",
                "groups": "/api/v1/groups/RQjOUs-uTSihyEm1mpSYNg",
                "href": "/api/v1/appgroups/CJUZ2RTpQTWLJJMPVwW0pQ"
            },
            "uuid_url": "CJUZ2RTpQTWLJJMPVwW0pQ"
        },
        {
            "app": {
                "app_uuid_url": "9m6LGDHhTWubkb4gU6O9NA",
                "name": "TestSaaSApp2"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "xovNEzLaQVibmAj2mOD5DA",
                "name": "Soha Employees"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/9m6LGDHhTWubkb4gU6O9NA",
                "groups": "/api/v1/groups/xovNEzLaQVibmAj2mOD5DA",
                "href": "/api/v1/appgroups/XbuaBHIgQ4eJ_Z8Fl6VCsA"
            },
            "uuid_url": "XbuaBHIgQ4eJ_Z8Fl6VCsA"
        },
        {
            "app": {
                "app_uuid_url": "9m6LGDHhTWubkb4gU6O9NA",
                "name": "TestSaaSApp2"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "wyvJl9UcRt2M0LW1U9j2WA",
                "name": "WebGroup"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/9m6LGDHhTWubkb4gU6O9NA",
                "groups": "/api/v1/groups/wyvJl9UcRt2M0LW1U9j2WA",
                "href": "/api/v1/appgroups/VNLrgmCITGyWJcJPk_jM_g"
            },
            "uuid_url": "VNLrgmCITGyWJcJPk_jM_g"
        },
        {
            "app": {
                "app_uuid_url": "9m6LGDHhTWubkb4gU6O9NA",
                "name": "TestSaaSApp2"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Cloud Directory",
                "dir_uuid_url": "DMzkC7IvTkiLiRN6cGWxMw",
                "group_uuid_url": "aITPkYE1QRipnk5S4TOT1w",
                "name": "Admins"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/9m6LGDHhTWubkb4gU6O9NA",
                "groups": "/api/v1/groups/aITPkYE1QRipnk5S4TOT1w",
                "href": "/api/v1/appgroups/484V6youRwuYiGkQqlahRA"
            },
            "uuid_url": "484V6youRwuYiGkQqlahRA"
        },
        {
            "app": {
                "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
                "name": "Saleforce"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Cloud Directory",
                "dir_uuid_url": "DMzkC7IvTkiLiRN6cGWxMw",
                "group_uuid_url": "rHB7BUZXSvab74JrFFcT7A",
                "name": "Users"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
                "groups": "/api/v1/groups/rHB7BUZXSvab74JrFFcT7A",
                "href": "/api/v1/appgroups/3JUHXZVpSym4zQNuXEWxSw"
            },
            "uuid_url": "3JUHXZVpSym4zQNuXEWxSw"
        },
        {
            "app": {
                "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
                "name": "Saleforce"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Cloud Directory",
                "dir_uuid_url": "DMzkC7IvTkiLiRN6cGWxMw",
                "group_uuid_url": "aITPkYE1QRipnk5S4TOT1w",
                "name": "Admins"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
                "groups": "/api/v1/groups/aITPkYE1QRipnk5S4TOT1w",
                "href": "/api/v1/appgroups/s8qxwBDsR_-iD_9ZEC-NzQ"
            },
            "uuid_url": "s8qxwBDsR_-iD_9ZEC-NzQ"
        },
        {
            "app": {
                "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
                "name": "Saleforce"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "wyvJl9UcRt2M0LW1U9j2WA",
                "name": "WebGroup"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
                "groups": "/api/v1/groups/wyvJl9UcRt2M0LW1U9j2WA",
                "href": "/api/v1/appgroups/oCaNvryOR3u68lDqwj-e0A"
            },
            "uuid_url": "oCaNvryOR3u68lDqwj-e0A"
        },
        {
            "app": {
                "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
                "name": "Saleforce"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "Xged4sjbTe-wzz57P_S_sA",
                "name": "RDPGroup"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
                "groups": "/api/v1/groups/Xged4sjbTe-wzz57P_S_sA",
                "href": "/api/v1/appgroups/se-8NU6JRNmg_mC0tu_oGg"
            },
            "uuid_url": "se-8NU6JRNmg_mC0tu_oGg"
        },
        {
            "app": {
                "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
                "name": "Saleforce"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "xovNEzLaQVibmAj2mOD5DA",
                "name": "Soha Employees"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
                "groups": "/api/v1/groups/xovNEzLaQVibmAj2mOD5DA",
                "href": "/api/v1/appgroups/nQbkuWuARzOHio2GJsHFbQ"
            },
            "uuid_url": "nQbkuWuARzOHio2GJsHFbQ"
        },
        {
            "app": {
                "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
                "name": "Saleforce"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "Cl2zMHneTneH8h3Dv_dFLQ",
                "name": "UniversalGroup167"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
                "groups": "/api/v1/groups/Cl2zMHneTneH8h3Dv_dFLQ",
                "href": "/api/v1/appgroups/LaOvDDiDTuuEzMBGjz897Q"
            },
            "uuid_url": "LaOvDDiDTuuEzMBGjz897Q"
        },
        {
            "app": {
                "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
                "name": "Saleforce"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "umtuOBTPRGSj8bSbDgJ7ng",
                "name": "SP2Group235"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
                "groups": "/api/v1/groups/umtuOBTPRGSj8bSbDgJ7ng",
                "href": "/api/v1/appgroups/MQLllWZzRWm4EhAFnyCt8w"
            },
            "uuid_url": "MQLllWZzRWm4EhAFnyCt8w"
        },
        {
            "app": {
                "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
                "name": "Saleforce"
            },
            "enable_mfa": "inherit",
            "group": {
                "dir_name": "Pelicancloud",
                "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
                "group_uuid_url": "RQjOUs-uTSihyEm1mpSYNg",
                "name": "Domain Users"
            },
            "resource_uri": {
                "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
                "groups": "/api/v1/groups/RQjOUs-uTSihyEm1mpSYNg",
                "href": "/api/v1/appgroups/P9AlfsH5SeCwfvprIRpIrg"
            },
            "uuid_url": "P9AlfsH5SeCwfvprIRpIrg"
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. For pagination, set offset the number of members to skip in the object list.

  3. For a pagination, set limit to specify the maximum number of members to return in the response.

  4. Optionally, set expand to true to include additional members in the response.

  5. Make a GET request to /crux/v1/mgmt-pop/appgroups{?contractId,offset,limit,expand}.

  6. The operation responds with an array of AppGroup objects.

Get an application group

Get details for a specific application group.

GET /crux/v1/mgmt-pop/appgroups/{appGroupId}{?contractId,expand}

Sample: /crux/v1/mgmt-pop/appgroups/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV&expand=true

Parameter Type Sample Description
URL path parameters
appGroupId String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each application group.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.

Status 200 application/json

Object type: AppGroup

Download schema: app-group.json

Response body:

{
    "app": {
        "app_uuid_url": "DSany6qrSbKwgtks9z8SFQ",
        "name": "Saleforce"
    },
    "enable_mfa": "inherit",
    "group": {
        "dir_name": "Pelicancloud",
        "dir_uuid_url": "z2WI-DS9RAKWj4ecsYI3BA",
        "group_uuid_url": "umtuOBTPRGSj8bSbDgJ7ng",
        "name": "SP2Group235"
    },
    "resource_uri": {
        "apps": "/api/v1/apps/DSany6qrSbKwgtks9z8SFQ",
        "groups": "/api/v1/groups/umtuOBTPRGSj8bSbDgJ7ng",
        "href": "/api/v1/appgroups/MQLllWZzRWm4EhAFnyCt8w"
    },
    "uuid_url": "MQLllWZzRWm4EhAFnyCt8w"
}

  1. Run the List application groups operation and store the relevant appGroupId.

  2. Ensure you have your contractId query parameter.

  3. Optionally, set expand to true to include additional members in the response.

  4. Make a GET request to /crux/v1/mgmt-pop/appgroups/{appGroupId}{?contractId,expand}.

  5. The operation responds with an AppGroup object.

Get an audit logs report

Returns an audit log report with optional custom filters.

GET /crux/v1/mgmt-pop/application-reports/ops/query{?start,end,app,tz,limit}

Sample: /crux/v1/mgmt-pop/application-reports/ops/query?start=1548959400000&end=1563388199999&app=example-ssh–1.stage.akamai-access.com%2Cexample-tnl-ssh–1.stage.akamai-access.com%2CZgcTQNq4SPeHuOpGUakpRA.stage.akamai-access.com%2Cexample-ssh2-plog.stage.akamai-access.com%2Cexample-tnl1.stage.akamai-access.com&tz=Asia/Calcutta&limit=100

Parameter Type Sample Description
Required query parameters
end Integer 1563388199999 End epoch timestamp in seconds for the report duration.
start Integer 1548959400000 Start epoch timestamp in seconds for the report duration.
Optional query parameters
app String example-ssh-1.stage.akamai-access.com,example-tnl-ssh-1.stage.akamai-access.com,ZgcTQNq4SPeHuOpGUakpRA.stage.akamai-access.com,example-ssh2-plog.stage.akamai-access.com,example-tnl1.stage.akamai-access.com Hostname of the ssh/rdp type application
limit Integer 100 The upper limit of records returned by this operation.
tz String Asia/Calcutta The tz database timezone of the requested start and end parameters.

Status 200 application/json

Object type: AuditLogs

Download schema: auditlogs.json

Response body:

{
    "data": [
        {
            "ts": 1613809915306,
            "app": "example-ssh-1.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Chrome 88.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Karnataka",
            "uid": "example@akamai.com",
            "uip": "80.67.65.11",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1613462468839,
            "app": "example-ssh-1.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Firefox 85.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.158.208",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1613462214081,
            "app": "example-ssh-1.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Chrome 88.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.158.208",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1613461988128,
            "app": "example-ssh-1.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Chrome 88.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.158.208",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1613461143700,
            "app": "example-ssh-1.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Chrome 88.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.158.208",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1613460754336,
            "app": "example-ssh2-plog.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Chrome 88.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.158.208",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1613460753577,
            "app": "example-ssh2-plog.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Chrome 88.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.158.208",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1613460719019,
            "app": "example-ssh-1.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Chrome 88.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.158.208",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1613460718279,
            "app": "example-ssh-1.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Chrome 88.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.158.208",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1613460412327,
            "app": "example-ssh2-plog.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Chrome 88.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.158.208",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1613460386544,
            "app": "example-ssh-1.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Chrome 88.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.158.208",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1613042761788,
            "app": "example-ssh-1.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Chrome 88.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "ocspuser7",
            "uip": "183.82.152.62",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1612428917751,
            "app": "example-ssh-1.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Firefox 84.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.156.172",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        },
        {
            "ts": 1610026449164,
            "app": "example-ssh-1.stage.akamai-access.com",
            "rscd": "302",
            "browser": "Firefox 84.0",
            "os": "Mac OS X 10.15",
            "cc": "India",
            "state": "Andhra Pradesh",
            "uid": "example@akamai.com",
            "uip": "183.82.159.125",
            "di": "1a6e4f414c9d7604a829f83e1f469527079fa1464b5b41203d8e398744d38d63",
            "ral": []
        }
    ]
}

  1. Run the Get an application operation and store the host name.

  2. Set the app query parameter as the application host.

  3. Set the start, end, and tz timestamp parameters.

  4. Set limit to specify the maximum number of members to return in the response.

  5. Make a GET request to /crux/v1/mgmt-pop/application-reports/ops/query{?start,end,app,tz,limit}.

  6. The operation responds with a AuditLogs object.

List device inventory

Returns a list of inventories for all devices.

GET /crux/v1/device-posture/inventory/list{?deviceId,os,browser,riskRule,firewall,antiMalware,clientVersion,mobile,screenlock,biometric,jailbroken,diskEncryption,etpThreatDetected,cbHealthy,cbPolicy,crowdstrikeHealthy,etpClientStatus,certProfile,antiMalwareProfile,search,offset,limit,sortBy,sortOrder,contractId}

Sample: /crux/v1/device-posture/inventory/list?deviceId=472d4ebbf2a9e9b05c6b1c366fb7df801d0fe59d18cf74e3a15476ba42549c6f&os=windows&browser=safari&riskRule=12345678&firewall=good&antiMalware=good&clientVersion=0.3.0&mobile=true&screenlock=true&biometric=true&jailbroken=true&diskEncryption=true&etpThreatDetected=true&cbHealthy=true&cbPolicy=default_policy&crowdstrikeHealthy=true&etpClientStatus=installed&certProfile=%3CCert%20profile%20id%202%3E&antiMalwareProfile=%3CAM%20profile%20id%202%3E%2C%3CAM%20profile%20id%203%3E&search=device_name&offset=10&limit=30&sortBy=timestamp&sortOrder=DESC&contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
antiMalware Enumeration good Filter records by anti-malware status, Values are good or poor.
antiMalwareProfile Enumeration <AM profile id 2>,<AM profile id 3> Filter records by anti-malware profiles, Values are a comma separated list of IDs of anti-malware profiles configured like <Any Vendor profile id>, <AM profile id 2>, <AM profile id 3>, <AM profile id 4>, <AM profile id 5>.
biometric Boolean true When enabled, returns only devices with biometrics enabled in the response.
browser Enumeration safari Filter records by browser. Values are edge, firefox, chrome, or safari.
cbHealthy Boolean true When enabled, returns only devices with Carbon Black running in the response.
cbPolicy String default_policy Filter records by Carbon Black policy.
certProfile Enumeration <Cert profile id 2> Filter records by certificate profiles, Values are a comma separated list of IDs of the certificate profiles configured like <Cert profile id 1>, <Cert profile id 2>, <Cert profile id 3>.
clientVersion String 0.3.0 Filter records by client version.
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
crowdstrikeHealthy Boolean true When enabled, returns only devices with CrowdStrike running in the response.
deviceId String 472d4ebbf2a9e9b05c6b1c366fb7df801d0fe59d18cf74e3a15476ba42549c6f Filter records by device ID.
diskEncryption Boolean true When enabled, returns only devices with disk encryption in the response.
etpClientStatus Enumeration installed Filter records by ETP client installation status, Values are installed or not-installed.
etpThreatDetected Boolean true When enabled, returns only devices with ETP threats in the response.
firewall Enumeration good Filter records by firewall status. Values are good or poor.
jailbroken Boolean true When enabled, returns only devices that are jailbroken in the response.
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
mobile Boolean true When enabled, returns only mobile device records in the response.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.
os Enumeration windows Filter records by operating system. Values are mac, windows, ios or android.
riskRule Integer 12345678 Filter records by risk rule ID.
screenlock Boolean true When enabled, returns only devices with screen lock enabled in the response.
search String device_name Filter records by a user specified value.
sortBy Enumeration timestamp Column name to sort the record set by. Values are deviceName, deviceId, userName, os, timestamp, idpUserName, or id.
sortOrder Enumeration DESC The sort direction for the column, either ASC or DESC.

Status 200 application/json

Object type: DeviceInventory

Download schema: device-summary-reports.json

Response body:

{
    "meta": {
        "limit": 20,
        "offset": 20,
        "previous": "?limit=20&offset=0",
        "next": "?limit=20&offset=40",
        "total_count": 5
    },
    "objects": [
        {
            "anti_malware_info": [
                {
                    "name": "Carbon Black",
                    "passed": true
                },
                {
                    "name": "CrowdStrike Falcon Sensor",
                    "passed": true
                }
            ],
            "anti_malware_running": [
                "Carbon Black",
                "CrowdStrike Falcon Sensor"
            ],
            "anti_malware_status": [
                {
                    "name": "Any Vendor",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 1",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 2",
                    "passed": false
                }
            ],
            "browsers": [
                {
                    "name": "Safari",
                    "version": "11.1.1"
                }
            ],
            "carbon_black": {
                "last_contact": null,
                "policy_id": "N/A",
                "policy_name": "policyA",
                "sensor_version": "version123",
                "status": "Active"
            },
            "certificate_profile": [
                {
                    "name": "Certificate Profile 1",
                    "passed": false
                },
                {
                    "name": "Certificate Profile 2",
                    "passed": false
                },
                {
                    "name": "Certificate Profile 3",
                    "passed": true
                }
            ],
            "crowdstrike": {
                "sensor_version": "5.34.11501.0",
                "last_contact": "2020-08-26T03:10:46+00:00",
                "aid": "7445e54fef9f49059c1b08c72skdhfjk",
                "cid": "b8d9a8c2c8734cf8ab68c0a9rehfuegf",
                "validity": "Valid",
                "agent_status": "Healthy"
            },
            "client_version": "0.3.0",
            "device_id": "472d4ebbf2a9e9b05c6b1c366fb7df801d0fe59d18cf74e3a15476ba42549c6f",
            "device_name": "mac-device-1",
            "etp_signals": {
                "threat_detected": false
            },
            "idp_username": "username@akamai.com",
            "firewall_status": "poor",
            "etp_client_status": "not-installed",
            "mobile_device": false,
            "os_auto_update": true,
            "os_name": "Mac OS X",
            "os_update_timestamp": "2018-07-30T16:08:42Z",
            "os_version": "10.13.5",
            "risk_posture_tags": [
                {
                    "id": 395,
                    "name": "Finance Tag",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 412,
                    "name": "WindowsOS_Preferred",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 410,
                    "name": "MacOS_ONLY",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 413,
                    "name": "risk_tag_2",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 279,
                    "name": "risk_tag_1",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 382,
                    "name": "E2E-tag",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 401,
                    "name": "risk_tag_3",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 451,
                    "name": "mobile",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 411,
                    "name": "WindowsOS_only",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 396,
                    "name": "test tag",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                }
            ],
            "risk_posture_tiers": [
                {
                    "id": 430,
                    "name": "Low",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": true
                },
                {
                    "id": 429,
                    "name": "Medium",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.12.6 or 10.13.6 or 10.14.5."
                    ],
                    "tier": true
                },
                {
                    "id": 431,
                    "name": "High",
                    "passed": true,
                    "tier": true
                }
            ],
            "signal_timestamp": "2019-07-11T13:11:39.552703+00:00",
            "system_disk_encryption": false,
            "user_id": "test_user"
        },
        {
            "anti_malware_info": [
                {
                    "name": "McAfee VirusScan Enterprise",
                    "passed": true
                },
                {
                    "name": "CrowdStrike Falcon Sensor",
                    "passed": false
                }
            ],
            "anti_malware_running": [
                "McAfee VirusScan Enterprise"
            ],
            "anti_malware_status": [
                {
                    "name": "Any Vendor",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 1",
                    "passed": false
                },
                {
                    "name": "Anti-Malware Profile Example 2",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 3",
                    "passed": false
                }
            ],
            "browsers": [
                {
                    "name": "Chrome",
                    "version": "75.0.3770.100"
                },
                {
                    "name": "Safari",
                    "version": "12.1.1"
                }
            ],
            "carbon_black": {
                "last_contact": null,
                "policy_id": "N/A",
                "policy_name": "policyA",
                "sensor_version": "version123",
                "status": "Active"
            },
            "certificate_profile": [
                {
                    "name": "Certificate Profile 1",
                    "passed": true
                },
                {
                    "name": "Certificate Profile 2",
                    "passed": true
                },
                {
                    "name": "Certificate Profile 3",
                    "passed": true
                }
            ],
            "crowdstrike": {
                "sensor_version": "N/A",
                "last_contact": null,
                "aid": "7445e54fef9f49059c1b08c72skdhfjk",
                "cid": "b8d9a8c2c8734cf8ab68c0a9rehfuegf",
                "validity": "Invalid",
                "agent_status": "Unhealthy"
            },
            "client_version": "0.3.0",
            "device_id": "1c962e601cf36b2874ac1112117ccb6d179b3f5d0da7bf4d880d1a3707e0e761",
            "device_name": "mac-device-2",
            "etp_signals": {
                "threat_detected": false
            },
            "firewall_status": "good",
            "etp_client_status": "installed",
            "idp_username": "username@akamai.com",
            "mobile_device": false,
            "os_auto_update": true,
            "os_name": "Mac OS X",
            "os_update_timestamp": "2018-10-30T19:28:50Z",
            "os_version": "10.13.6",
            "risk_posture_tags": [
                {
                    "id": 395,
                    "name": "Finance Tag",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 412,
                    "name": "WindowsOS_Preferred",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 410,
                    "name": "MacOS_ONLY",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 413,
                    "name": "risk_tag_2",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 279,
                    "name": "risk_tag_1",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 382,
                    "name": "E2E-tag",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 401,
                    "name": "risk_tag_3",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                },
                {
                    "id": 451,
                    "name": "mobile",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 411,
                    "name": "WindowsOS_only",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 396,
                    "name": "test tag",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": false
                }
            ],
            "risk_posture_tiers": [
                {
                    "id": 430,
                    "name": "Low",
                    "passed": false,
                    "remediations": [
                        "Operating system version is out of date. Update your operating system to version 10.14.5."
                    ],
                    "tier": true
                },
                {
                    "id": 429,
                    "name": "Medium",
                    "passed": true,
                    "tier": true
                }
            ],
            "signal_timestamp": "2019-07-11T13:30:59.907087+00:00",
            "system_disk_encryption": true,
            "user_id": "test_user"
        },
        {
            "anti_malware_info": [
                {
                    "name": "Carbon Black",
                    "passed": true
                },
                {
                    "name": "CrowdStrike Falcon Sensor",
                    "passed": false
                }
            ],
            "anti_malware_running": [
                "Carbon Black"
            ],
            "anti_malware_status": [
                {
                    "name": "Any Vendor",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 1",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 2",
                    "passed": false
                },
                {
                    "name": "Anti-Malware Profile Example 3",
                    "passed": false
                }
            ],
            "browsers": [
                {
                    "name": "Chrome",
                    "version": "75.0.3770.90"
                },
                {
                    "name": "Safari",
                    "version": "12.1.1"
                }
            ],
            "carbon_black": {
                "last_contact": null,
                "policy_id": "N/A",
                "policy_name": "policyA",
                "sensor_version": "version123",
                "status": "Active"
            },
            "certificate_profile": [
                {
                    "name": "Certificate Profile 1",
                    "passed": false
                },
                {
                    "name": "Certificate Profile 2",
                    "passed": true
                },
                {
                    "name": "Certificate Profile 3",
                    "passed": true
                }
            ],
            "crowdstrike": {
                "sensor_version": "N/A",
                "last_contact": null,
                "aid": "N/A",
                "cid": "N/A",
                "validity": "Invalid",
                "agent_status": "Unhealthy"
            },
            "client_version": "0.3.0",
            "device_id": "369b5c8a97e0085f813720f7cbc9753e8b667d8112e49e656713fbaa0dbe5115",
            "device_name": "mac-device-3",
            "etp_signals": {
                "threat_detected": false
            },
            "firewall_status": "good",
            "etp_client_status": "installed",
            "idp_username": "username@akamai.com",
            "mobile_device": false,
            "os_auto_update": true,
            "os_name": "Mac OS X",
            "os_update_timestamp": "2019-05-23T03:13:44Z",
            "os_version": "10.14.5",
            "risk_posture_tags": [
                {
                    "id": 395,
                    "name": "Finance Tag",
                    "passed": false,
                    "remediations": [
                        "Safari is out of date or not supported. Update your version of Safari browser or use a supported browser."
                    ],
                    "tier": false
                },
                {
                    "id": 412,
                    "name": "WindowsOS_Preferred",
                    "passed": false,
                    "remediations": [
                        "Safari is out of date or not supported. Update your version of Safari browser or use a supported browser."
                    ],
                    "tier": false
                },
                {
                    "id": 410,
                    "name": "MacOS_ONLY",
                    "passed": false,
                    "remediations": [
                        "Safari is out of date or not supported. Update your version of Safari browser or use a supported browser."
                    ],
                    "tier": false
                },
                {
                    "id": 413,
                    "name": "risk_tag_2",
                    "passed": false,
                    "remediations": [
                        "Safari is out of date or not supported. Update your version of Safari browser or use a supported browser."
                    ],
                    "tier": false
                },
                {
                    "id": 279,
                    "name": "risk_tag_1",
                    "passed": true,
                    "tier": false
                },
                {
                    "id": 382,
                    "name": "E2E-tag",
                    "passed": true,
                    "tier": false
                },
                {
                    "id": 401,
                    "name": "risk_tag_3",
                    "passed": false,
                    "remediations": [
                        "Safari is out of date or not supported. Update your version of Safari browser or use a supported browser."
                    ],
                    "tier": false
                },
                {
                    "id": 451,
                    "name": "mobile",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 411,
                    "name": "WindowsOS_only",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 396,
                    "name": "test tag",
                    "passed": true,
                    "tier": false
                }
            ],
            "risk_posture_tiers": [
                {
                    "id": 430,
                    "name": "Low",
                    "passed": false,
                    "remediations": [
                        "Safari is out of date or not supported. Update your version of Safari browser or use a supported browser."
                    ],
                    "tier": true
                },
                {
                    "id": 429,
                    "name": "Medium",
                    "passed": true,
                    "tier": true
                }
            ],
            "signal_timestamp": "2019-07-11T13:36:42.587985+00:00",
            "system_disk_encryption": true,
            "user_id": "test_user"
        },
        {
            "browsers": [],
            "client_version": "0.9",
            "device_biometric": true,
            "device_id": "4B1CF385-01F3-4711-96B7-3A3DD7E354F9",
            "device_jailbroken": false,
            "device_name": "iPhone",
            "device_screen_lock": true,
            "idp_username": "username@akamai.com",
            "mobile_device": true,
            "os_auto_update": null,
            "os_build": "16F203",
            "os_name": "iOS",
            "os_update_timestamp": null,
            "os_version": "12.3.1",
            "risk_posture_tags": [
                {
                    "id": 395,
                    "name": "Finance Tag",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 412,
                    "name": "WindowsOS_Preferred",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 410,
                    "name": "MacOS_ONLY",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 413,
                    "name": "risk_tag_2",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 279,
                    "name": "risk_tag_1",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 382,
                    "name": "E2E-tag",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 401,
                    "name": "risk_tag_3",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 451,
                    "name": "mobile",
                    "passed": true,
                    "tier": false
                },
                {
                    "id": 411,
                    "name": "WindowsOS_only",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 396,
                    "name": "test tag",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                }
            ],
            "risk_posture_tiers": [
                {
                    "id": 430,
                    "name": "Low",
                    "passed": true,
                    "tier": true
                }
            ],
            "signal_timestamp": "2019-07-12T18:55:04.240586+00:00",
            "user_id": "245c5c846caad74f21e2e44f5df2a49d"
        },
        {
            "browsers": [],
            "client_version": "0.9",
            "device_biometric": true,
            "device_id": "128DCDE5-ACB0-411A-8428-5BEAAD983D0C",
            "device_jailbroken": false,
            "device_name": "iPhone",
            "device_screen_lock": true,
            "idp_username": "username@akamai.com",
            "mobile_device": true,
            "os_auto_update": null,
            "os_build": "16F203",
            "os_name": "iOS",
            "os_update_timestamp": null,
            "os_version": "12.3.1",
            "risk_posture_tags": [
                {
                    "id": 395,
                    "name": "Finance Tag",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 412,
                    "name": "WindowsOS_Preferred",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 410,
                    "name": "MacOS_ONLY",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 413,
                    "name": "risk_tag_2",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 279,
                    "name": "risk_tag_1",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 382,
                    "name": "E2E-tag",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 401,
                    "name": "risk_tag_3",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 451,
                    "name": "mobile",
                    "passed": true,
                    "tier": false
                },
                {
                    "id": 411,
                    "name": "WindowsOS_only",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                },
                {
                    "id": 396,
                    "name": "test tag",
                    "passed": false,
                    "remediations": [
                        "Unsupported operating system."
                    ],
                    "tier": false
                }
            ],
            "risk_posture_tiers": [
                {
                    "id": 430,
                    "name": "Low",
                    "passed": true,
                    "tier": true
                }
            ],
            "signal_timestamp": "2019-07-12T00:07:04.899075+00:00",
            "user_id": "245c5c846caad74f21e2e44f5df2a49d"
        }
    ]
}

  1. Optionally, set the deviceId, os, browser, riskRule, firewall, antiMalware, clientVersion, mobile, screenlock, biometric, jailbroken, diskEncryption, etpThreatDetected, cbHealthy, cbPolicy, crowdstrikeHealthy, and search query parameters.

  2. Optionally, set the offset, limit, sortBy, and sortOrder query parameters for pagination.

  3. Ensure you have your contractId query parameter.

  4. Make a GET request to /crux/v1/device-posture/inventory/list{?deviceId,os,browser,riskRule,firewall,antiMalware,clientVersion,mobile,screenlock,biometric,jailbroken,diskEncryption,etpThreatDetected,cbHealthy,cbPolicy,crowdstrikeHealthy,search,offset,limit,sortBy,sortOrder,contractId}.

  5. The operation responds with a DeviceInventory object.

List device activity

Returns a list of activity metrics of devices connecting to your applications.

GET /crux/v1/device-posture/inventory/summary/device-roll-ups{?contractId}

Sample: /crux/v1/device-posture/inventory/summary/device-roll-ups?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Browser

Download schema: device-summary-browsers.json

Response body:

[
    {
        "timestamp": "2019-03-19T21:00:00+00:00",
        "check_in_count": 40,
        "device_count": 250
    },
    {
        "timestamp": "2019-03-20T00:00:00+00:00",
        "check_in_count": 45,
        "device_count": 250
    },
    {
        "timestamp": "2019-03-20T13:00:00+00:00",
        "check_in_count": 50,
        "device_count": 250
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/inventory/summary/device-roll-ups{?contractId}.

  3. The operation responds with an Activity object.

List device risk assessment

Returns a list of activity metrics for risk assessment rules of devices connected to your applications.

GET /crux/v1/device-posture/inventory/summary/risk-assessment{?contractId}

Sample: /crux/v1/device-posture/inventory/summary/risk-assessment?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: RiskAssessment

Download schema: device-summary-risk-assessment.json

Response body:

[
    {
        "name": "Finance Tag",
        "tier": false,
        "id": 298,
        "count": 19
    },
    {
        "name": "Engineering Tag",
        "tier": false,
        "id": 299,
        "count": 57
    },
    {
        "name": "Low",
        "tier": true,
        "id": 255,
        "count": 86
    },
    {
        "name": "Medium",
        "tier": true,
        "id": 256,
        "count": 15
    },
    {
        "name": "High",
        "tier": true,
        "id": 257,
        "count": 150
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/inventory/summary/risk-assessment{?contractId}.

  3. The operation responds with a RiskAssessment object.

List browser activity

Returns a list of activity metrics for installed browsers of devices connecting to your applications.

GET /crux/v1/device-posture/inventory/summary/browsers{?contractId}

Sample: /crux/v1/device-posture/inventory/summary/browsers?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Browser

Download schema: device-summary-browsers.json

Response body:

[
    {
        "name": "Chrome",
        "latest": 11100,
        "custom": 12,
        "outdated": 124
    },
    {
        "name": "Edge",
        "latest": 36,
        "custom": 3594,
        "outdated": 6143
    },
    {
        "name": "Firefox",
        "latest": 1349,
        "custom": 42,
        "outdated": 1483
    },
    {
        "name": "Internet Explorer",
        "latest": 11525,
        "custom": 0,
        "outdated": 180
    },
    {
        "name": "Opera",
        "latest": 72,
        "custom": 7,
        "outdated": 0
    },
    {
        "name": "Safari",
        "latest": 18,
        "custom": 2,
        "outdated": 0
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/inventory/summary/browsers{?contractId}.

  3. The operation responds with a Browser object.

List operating system activity

Returns a list of activity metrics for installed operating systems of devices connecting to your applications.

GET /crux/v1/device-posture/inventory/summary/os{?contractId}

Sample: /crux/v1/device-posture/inventory/summary/os?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Os

Download schema: device-summary-os.json

Response body:

[
    {
        "name": "Mac OS X",
        "latest": 33,
        "updated": 26,
        "outdated": 65,
        "custom": 191
    },
    {
        "name": "Windows 10",
        "latest": 61,
        "updated": 3,
        "outdated": 0,
        "custom": 0
    },
    {
        "name": "iOS",
        "latest": 63,
        "updated": 0,
        "outdated": 0,
        "custom": 5
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/inventory/summary/os{?contractId}.

  3. The operation responds with a Os object.

List system disk encryption

Returns a list of activity metrics for disk encryption signals acquired from devices accessing your applications. Statuses are grouped by value and summed by count in the response.

GET /crux/v1/device-posture/inventory/summary/system-disk-encryption{?contractId}

Sample: /crux/v1/device-posture/inventory/summary/system-disk-encryption?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Signal

Download schema: device-summary-signals.json

Response body:

[
    {
        "value": "good",
        "count": 129
    },
    {
        "value": "poor",
        "count": 122
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/inventory/summary/system-disk-encryption{?contractId}.

  3. The operation responds with a Signal object.

List firewall status

Returns a list of activity metrics for firewall status signals acquired from devices accessing your applications. Statuses are grouped by value and summed by count in the response.

GET /crux/v1/device-posture/inventory/summary/firewall-status{?contractId}

Sample: /crux/v1/device-posture/inventory/summary/firewall-status?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Signal

Download schema: device-summary-signals.json

Response body:

[
    {
        "value": "good",
        "count": 129
    },
    {
        "value": "poor",
        "count": 122
    }
]

List anti-malware status

Returns a list of activity metrics for anti-malware status signals acquired from devices accessing your applications. Statuses are grouped by value and summed by count in the response.

GET /crux/v1/device-posture/inventory/summary/anti-malware-status{?contractId}

Sample: /crux/v1/device-posture/inventory/summary/anti-malware-status?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Signal

Download schema: device-summary-signals.json

Response body:

[
    {
        "value": "good",
        "count": 129
    },
    {
        "value": "poor",
        "count": 122
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/inventory/summary/anti-malware-status{?contractId}.

  3. The operation responds with a Signal object.

List devices with biometrics

Returns a list of activity metrics for biometrics signals acquired from devices accessing your applications. Statuses are grouped by value and summed by count in the response.

GET /crux/v1/device-posture/inventory/summary/device-biometric{?contractId}

Sample: /crux/v1/device-posture/inventory/summary/device-biometric?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Signal

Download schema: device-summary-signals.json

Response body:

[
    {
        "value": "good",
        "count": 129
    },
    {
        "value": "poor",
        "count": 122
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/inventory/summary/device-biometric{?contractId}.

  3. The operation responds with a Signal object.

List jailbroken devices

Returns a list of activity metrics for jailbroken device signals acquired from devices accessing your applications. Statuses are grouped by value and summed by count in the response.

GET /crux/v1/device-posture/inventory/summary/device-jailbroken{?contractId}

Sample: /crux/v1/device-posture/inventory/summary/device-jailbroken?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Signal

Download schema: device-summary-signals.json

Response body:

[
    {
        "value": "good",
        "count": 129
    },
    {
        "value": "poor",
        "count": 122
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/inventory/summary/device-jailbroken{?contractId}.

  3. The operation responds with a Signal object.

List device screen lock

Returns a list of activity metrics for screen lock device signals acquired from devices accessing your applications. Statuses are grouped by value and summed by count in the response.

GET /crux/v1/device-posture/inventory/summary/device-screen-lock{?contractId}

Sample: /crux/v1/device-posture/inventory/summary/device-screen-lock?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Signal

Download schema: device-summary-signals.json

Response body:

[
    {
        "value": "good",
        "count": 129
    },
    {
        "value": "poor",
        "count": 122
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/inventory/summary/device-screen-lock{?contractId}.

  3. The operation responds with a Signal object.

Clear device

Marks a device as safe and clear from ETP threats.

PUT /crux/v1/device-posture/inventory/device/{deviceId}/op/clear{?contractId}

Sample: /crux/v1/device-posture/inventory/device/12345/op/clear?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
deviceId Integer 12345 A unique identifier for a particular device.
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Run the List device inventory operation and store the relevant deviceId.

  2. Ensure you have your contractId query parameter.

  3. Make a PUT request to /crux/v1/device-posture/inventory/device/{deviceId}/op/clear{?contractId}.

List device history

Returns a list of history information for a particular device.

GET /crux/v1/device-posture/inventory/device-history/{deviceId}{?contractId}

Sample: /crux/v1/device-posture/inventory/device-history/12345?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
deviceId Integer 12345 A unique identifier for a particular device.
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: History

Download schema: device-history-reports.json

Response body:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "device_name": "test-device",
            "idp_username": "username@akamai.com",
            "client_version": "1.3.2",
            "user_id": "Administrator",
            "os_name": "Microsoft Windows 10 Pro",
            "os_version": "10.0.18362.239",
            "signal_timestamp": "2019-10-16T16:52:47.116999+00:00",
            "os_update_timestamp": "2019-10-09T00:00:00Z",
            "os_auto_update": true,
            "anti_malware_info": [
                {
                    "name": "McAfee VirusScan Enterprise",
                    "passed": true
                },
                {
                    "name": "CrowdStrike Falcon Sensor",
                    "passed": true
                }
            ],
            "anti_malware_running": [
                "McAfee VirusScan Enterprise",
                "CrowdStrike Falcon Sensor"
            ],
            "anti_malware_status": [
                {
                    "name": "Any Vendor",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 1",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 2",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 3",
                    "passed": false
                }
            ],
            "firewall_status": "poor",
            "etp_client_status": "installed",
            "system_disk_encryption": false,
            "browsers": [
                {
                    "name": "Edge",
                    "version": "44.18362.1.0"
                },
                {
                    "name": "Chrome",
                    "version": "77.0.3865.120"
                },
                {
                    "name": "Firefox",
                    "version": "60.9.0"
                },
                {
                    "name": "Internet Explorer",
                    "version": "11.0.135"
                }
            ]
        },
        {
            "device_name": "test-device",
            "idp_username": "username@akamai.com",
            "client_version": "1.3.2",
            "user_id": "Administrator",
            "os_name": "Microsoft Windows 10 Pro",
            "os_version": "10.0.18362.239",
            "signal_timestamp": "2019-10-15T20:38:28.981016+00:00",
            "os_update_timestamp": "2019-10-09T00:00:00Z",
            "os_auto_update": true,
            "anti_malware_info": [
                {
                    "name": "McAfee VirusScan Enterprise",
                    "passed": true
                },
                {
                    "name": "CrowdStrike Falcon Sensor",
                    "passed": false
                }
            ],
            "anti_malware_running": [
                "McAfee VirusScan Enterprise"
            ],
            "anti_malware_status": [
                {
                    "name": "Any Vendor",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 1",
                    "passed": false
                },
                {
                    "name": "Anti-Malware Profile Example 2",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 3",
                    "passed": false
                }
            ],
            "firewall_status": "poor",
            "etp_client_status": "installed",
            "system_disk_encryption": false,
            "browsers": [
                {
                    "name": "Edge",
                    "version": "44.18362.1.0"
                },
                {
                    "name": "Chrome",
                    "version": "77.0.3865.90"
                },
                {
                    "name": "Firefox",
                    "version": "60.9.0"
                },
                {
                    "name": "Internet Explorer",
                    "version": "11.0.135"
                }
            ]
        },
        {
            "device_name": "test-device",
            "idp_username": "username@akamai.com",
            "client_version": "1.3.2",
            "user_id": "Administrator",
            "os_name": "Microsoft Windows 10 Pro",
            "os_version": "10.0.18362.239",
            "signal_timestamp": "2019-10-09T01:18:41.082591+00:00",
            "os_update_timestamp": "2019-09-12T00:00:00Z",
            "os_auto_update": true,
            "anti_malware_info": [
                {
                    "name": "McAfee VirusScan Enterprise",
                    "passed": true
                },
                {
                    "name": "CrowdStrike Falcon Sensor",
                    "passed": false
                }
            ],
            "anti_malware_running": [
                "McAfee VirusScan Enterprise"
            ],
            "anti_malware_status": [
                {
                    "name": "Any Vendor",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 1",
                    "passed": false
                },
                {
                    "name": "Anti-Malware Profile Example 2",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 3",
                    "passed": false
                }
            ],
            "firewall_status": "poor",
            "etp_client_status": "not-installed",
            "system_disk_encryption": false,
            "browsers": [
                {
                    "name": "Edge",
                    "version": "44.18362.1.0"
                },
                {
                    "name": "Chrome",
                    "version": "77.0.3865.90"
                },
                {
                    "name": "Firefox",
                    "version": "60.9.0"
                },
                {
                    "name": "Internet Explorer",
                    "version": "11.0.135"
                }
            ]
        },
        {
            "device_name": "test-device",
            "idp_username": "username@akamai.com",
            "client_version": "1.3.2",
            "user_id": "",
            "os_name": "Microsoft Windows 10 Pro",
            "os_version": "10.0.18362.239",
            "signal_timestamp": "2019-10-03T21:27:20.510988+00:00",
            "os_update_timestamp": "2019-09-12T00:00:00Z",
            "os_auto_update": true,
            "anti_malware_info": [
                {
                    "name": "McAfee VirusScan Enterprise",
                    "passed": true
                },
                {
                    "name": "CrowdStrike Falcon Sensor",
                    "passed": false
                }
            ],
            "anti_malware_running": [
                "McAfee VirusScan Enterprise"
            ],
            "anti_malware_status": [
                {
                    "name": "Any Vendor",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 1",
                    "passed": false
                },
                {
                    "name": "Anti-Malware Profile Example 2",
                    "passed": true
                },
                {
                    "name": "Anti-Malware Profile Example 3",
                    "passed": false
                }
            ],
            "firewall_status": "poor",
            "etp_client_status": "installed",
            "system_disk_encryption": false,
            "browsers": [
                {
                    "name": "Edge",
                    "version": "44.18362.1.0"
                },
                {
                    "name": "Chrome",
                    "version": "77.0.3865.90"
                },
                {
                    "name": "Firefox",
                    "version": "60.9.0"
                },
                {
                    "name": "Internet Explorer",
                    "version": "11.0.135"
                }
            ]
        }
    ]
}

  1. Run the List device inventory operation and store the relevant deviceId.

  2. Ensure you have your contractId query parameter.

  3. Make a GET request to /crux/v1/device-posture/inventory/device-history/{deviceId}{?contractId}.

  4. The operation responds with a History object.

List available operating systems

Returns a list of supported operating systems for risk assessment. Unlisted operating systems are not supported for risk assessment.

GET /crux/v1/device-posture/risk-assessment/os-names{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/os-names?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: AvailableOs

Download schema: risk-assessment-available-os.json

Response body:

[
    {
        "name": "Mac OS X",
        "mobile": false
    },
    {
        "name": "Windows",
        "mobile": false
    },
    {
        "name": "iOS",
        "mobile": true
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/risk-assessment/os-names{?contractId}.

  3. The operation responds with a AvailableOs object.

List available operating system versions

Returns a list of supported operating system versions for risk assessment. Unlisted versions are not supported for risk assessment.

GET /crux/v1/device-posture/risk-assessment/available-os-ver{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/available-os-ver?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: AvailableOsVersion

Download schema: risk-assessment-available-os-ver.json

Response body:

[
    {
        "name": "Android",
        "latest": "10",
        "date": "2019-09-03",
        "upToDate": [
            {
                "version": "9.0",
                "date": "2018-08-06"
            }
        ]
    },
    {
        "name": "iOS",
        "latest": "13.4.1 (17E262)",
        "date": "2020-04-07",
        "upToDate": [
            {
                "version": "12.4.2 (16G114)",
                "date": "2019-09-26"
            },
            {
                "version": "11.4 (15F79)",
                "date": "2018-05-29"
            }
        ]
    },
    {
        "name": "macOS",
        "latest": "Big Sur 11.2 (20D64)",
        "date": "2021-02-01",
        "upToDate": [
            {
                "version": "Catalina 10.15.7 (19H512)",
                "date": "2021-02-01"
            },
            {
                "version": "Mojave 10.14.6 (18G8012)",
                "date": "2021-02-01"
            },
            {
                "version": "High Sierra 10.13.6 (17G14042)",
                "date": "2020-11-12"
            },
            {
                "version": "Sierra 10.12.6 (16G2136)",
                "date": "2019-09-26"
            }
        ]
    },
    {
        "name": "Windows",
        "latest": "1909 (18363.815)",
        "date": "2020-04-21",
        "upToDate": [
            {
                "version": "1903 (18362.815)",
                "date": "2020-04-21"
            },
            {
                "version": "1809 (17763.1192)",
                "date": "2020-04-21"
            },
            {
                "version": "1803 (17134.1456)",
                "date": "2020-04-21"
            },
            {
                "version": "1709 (16299.1806)",
                "date": "2020-04-14"
            },
            {
                "version": "1703 (15063.2108)",
                "date": "2019-10-08"
            }
        ]
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/risk-assessment/available-os-ver{?contractId}.

  3. The operation responds with an AvailableOsVersion object.

List available browser versions

Returns a list of supported browser versions for risk assessment. Unlisted browsers are not supported for risk assessment.

GET /crux/v1/device-posture/risk-assessment/available-browsers{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/available-browsers?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: BrowserVersion

Download schema: risk-assessment-available-browser-ver.json

Response body:

[
    {
        "name": "Chrome",
        "latest": "81.0.4044.129",
        "date": "2020-04-27"
    },
    {
        "name": "Firefox",
        "latest": "75.0",
        "date": "2020-04-06"
    },
    {
        "name": "Opera",
        "latest": "68.0.3618.63",
        "date": "2020-04-29"
    },
    {
        "name": "Safari",
        "latest": "13.1",
        "date": "2020-03-24"
    },
    {
        "name": "Edge",
        "latest": "79.0.309.68",
        "date": "2020-01-16"
    },
    {
        "name": "Internet Explorer",
        "latest": "11.0.185",
        "date": "2020-04-14"
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/risk-assessment/available-browsers{?contractId}.

  3. The operation responds with an BrowserVersion object.

List available client versions

Returns a list of supported client versions for risk assessment. Unlisted client versions are not supported for risk assessment.

GET /crux/v1/device-posture/risk-assessment/available-client-ver{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/available-client-ver?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: AvailableClientVersion

Download schema: risk-assessment-available-client-ver.json

Response body:

{
    "latest": "2.1.1",
    "date": "2020-11-10",
    "perOSVersions": [
        {
            "platform": "Android",
            "latest": "2.1.1",
            "date": "2020-09-08"
        },
        {
            "platform": "iOS",
            "latest": "2.1.2",
            "date": "2020-11-05"
        },
        {
            "platform": "macOS",
            "latest": "2.1.2",
            "date": "2020-11-12",
            "upToDate": [
                {
                    "version": "2.1.1",
                    "date": "2020-11-05"
                },
                {
                    "version": "2.0.4",
                    "date": "2019-10-29"
                },
                {
                    "version": "2.0.3",
                    "date": "2019-03-29"
                },
                {
                    "version": "1.4.0",
                    "date": "2019-03-29"
                }
            ]
        },
        {
            "platform": "Windows",
            "latest": "2.1.2",
            "date": "2020-11-10",
            "upToDate": [
                {
                    "version": "2.0.4",
                    "date": "2020-11-10"
                },
                {
                    "version": "2.0.3",
                    "date": "2020-11-10"
                },
                {
                    "version": "2.0",
                    "date": "2020-11-10"
                },
                {
                    "version": "1.4.0",
                    "date": "2020-11-10"
                }
            ]
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/risk-assessment/available-client-ver{?contractId}.

  3. The operation responds with an AvailableClientVersion object.

List chosen versions

Returns a list of chosen versions of different risk assessment dimensions.

GET /crux/v1/device-posture/risk-assessment/chosen-versions{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/chosen-versions?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: ChosenVersions

Download schema: risk-assessment-chosen-versions.json

Response body:

{
    "os": [
        {
            "name": "Android",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "name": "iOS",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "name": "macOS",
            "custom": [
                "17F77",
                "18A391",
                "18G1012",
                "18G84",
                "18G95",
                "18G103"
            ],
            "upToDate": [
                "Catalina 10.15.7 (19H15)",
                "Mojave 10.14.6 (18G1012)",
                "High Sierra 10.13.6 (17G6030)",
                "Sierra 10.12.6 (16G1918)"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Windows",
            "custom": [
                "18362.239",
                "7601.24511",
                "18362.295",
                "18362.356"
            ],
            "upToDate": [
                "2004 (19041.630)",
                "1909 (18363.1198)",
                "1903 (18362.1198)",
                "1809 (17763.1577)",
                "1803 (17134.1845)",
                "1709 (16299.2166)",
                "1703 (15063.2108)"
            ],
            "gracePeriod": 180
        }
    ],
    "client": {
        "name": "EAA Client",
        "gracePeriod": 1
    },
    "browsers": [
        {
            "name": "Chrome",
            "custom": [
                "78.0.3904.97"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Edge",
            "custom": [
                "44.17763.1.0",
                "42.17134.1.0",
                "42.17134.1038.0",
                "44.17763.831.0",
                "44.17763.771.0"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Firefox",
            "custom": [
                "69.0.3"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Internet Explorer",
            "custom": [
                "11.0.155"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Opera",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "name": "Safari",
            "custom": [],
            "gracePeriod": 180
        }
    ],
    "eaaclient": [
        {
            "platform": "Android",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "platform": "iOS",
            "custom": [
                "2.1.2"
            ],
            "gracePeriod": 180
        },
        {
            "platform": "macOS",
            "custom": [],
            "upToDate": [
                "10.13.7"
            ],
            "gracePeriod": 180
        },
        {
            "platform": "windows",
            "custom": [],
            "upToDate": [
                "2.1.1"
            ],
            "gracePeriod": 180
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/risk-assessment/chosen-versions{?contractId}.

  3. The operation responds with a ChosenVersions object.

Modify chosen versions

Updates the chosen versions selection of different risk assessment dimensions.

PUT /crux/v1/device-posture/risk-assessment/chosen-versions{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/chosen-versions?contractId=F-EMGSGV

Content-Type: application/json

Object type: ChosenVersions

Download schema: risk-assessment-chosen-versions.json

Request body:

{
    "os": [
        {
            "name": "Android",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "name": "iOS",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "name": "macOS",
            "custom": [
                "17F77",
                "18A391",
                "18G1012",
                "18G84",
                "18G95",
                "18G103"
            ],
            "upToDate": [
                "Catalina 10.15.7 (19H15)",
                "Mojave 10.14.6 (18G1012)",
                "High Sierra 10.13.6 (17G6030)",
                "Sierra 10.12.6 (16G1918)"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Windows",
            "custom": [
                "18362.239",
                "7601.24511",
                "18362.295",
                "18362.356"
            ],
            "upToDate": [
                "2004 (19041.630)",
                "1909 (18363.1198)",
                "1903 (18362.1198)",
                "1809 (17763.1577)",
                "1803 (17134.1845)",
                "1709 (16299.2166)",
                "1703 (15063.2108)"
            ],
            "gracePeriod": 180
        }
    ],
    "client": {
        "name": "EAA Client",
        "gracePeriod": 1
    },
    "browsers": [
        {
            "name": "Chrome",
            "custom": [
                "78.0.3904.97"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Edge",
            "custom": [
                "44.17763.1.0",
                "42.17134.1.0",
                "42.17134.1038.0",
                "44.17763.831.0",
                "44.17763.771.0"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Firefox",
            "custom": [
                "69.0.3"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Internet Explorer",
            "custom": [
                "11.0.155"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Opera",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "name": "Safari",
            "custom": [],
            "gracePeriod": 180
        }
    ],
    "eaaclient": [
        {
            "platform": "Android",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "platform": "iOS",
            "custom": [
                "2.1.2"
            ],
            "gracePeriod": 180
        },
        {
            "platform": "macOS",
            "custom": [],
            "upToDate": [
                "10.13.7"
            ],
            "gracePeriod": 180
        },
        {
            "platform": "windows",
            "custom": [],
            "upToDate": [
                "2.1.1"
            ],
            "gracePeriod": 180
        }
    ]
}
Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Ensure you have your contractId query parameter.

  2. Run the List chosen versions operation and store the response object.

  3. Modify the ChosenVersions object.

  4. PUT the object to /crux/v1/device-posture/risk-assessment/chosen-versions{?contractId}.

Test chosen versions

Tests the selected versions against the existing risk assessment rules.

POST /crux/v1/device-posture/risk-assessment/chosen-versions/test{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/chosen-versions/test?contractId=F-EMGSGV

Content-Type: application/json

Object type: ChosenVersions

Download schema: risk-assessment-chosen-versions.json

Request body:

{
    "os": [
        {
            "name": "Android",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "name": "iOS",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "name": "macOS",
            "custom": [
                "17F77",
                "18A391",
                "18G1012",
                "18G84",
                "18G95",
                "18G103"
            ],
            "upToDate": [
                "Catalina 10.15.7 (19H15)",
                "Mojave 10.14.6 (18G1012)",
                "High Sierra 10.13.6 (17G6030)",
                "Sierra 10.12.6 (16G1918)"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Windows",
            "custom": [
                "18362.239",
                "7601.24511",
                "18362.295",
                "18362.356"
            ],
            "upToDate": [
                "2004 (19041.630)",
                "1909 (18363.1198)",
                "1903 (18362.1198)",
                "1809 (17763.1577)",
                "1803 (17134.1845)",
                "1709 (16299.2166)",
                "1703 (15063.2108)"
            ],
            "gracePeriod": 180
        }
    ],
    "client": {
        "name": "EAA Client",
        "gracePeriod": 1
    },
    "browsers": [
        {
            "name": "Chrome",
            "custom": [
                "78.0.3904.97"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Edge",
            "custom": [
                "44.17763.1.0",
                "42.17134.1.0",
                "42.17134.1038.0",
                "44.17763.831.0",
                "44.17763.771.0"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Firefox",
            "custom": [
                "69.0.3"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Internet Explorer",
            "custom": [
                "11.0.155"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Opera",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "name": "Safari",
            "custom": [],
            "gracePeriod": 180
        }
    ],
    "eaaclient": [
        {
            "platform": "Android",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "platform": "iOS",
            "custom": [
                "2.1.2"
            ],
            "gracePeriod": 180
        },
        {
            "platform": "macOS",
            "custom": [],
            "upToDate": [
                "10.13.7"
            ],
            "gracePeriod": 180
        },
        {
            "platform": "windows",
            "custom": [],
            "upToDate": [
                "2.1.1"
            ],
            "gracePeriod": 180
        }
    ]
}
Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: RiskAssessment

Download schema: device-summary-risk-assessment.json

Response body:

[
    {
        "name": "Finance Tag",
        "tier": false,
        "id": 298,
        "count": 19
    },
    {
        "name": "Engineering Tag",
        "tier": false,
        "id": 299,
        "count": 57
    },
    {
        "name": "Low",
        "tier": true,
        "id": 255,
        "count": 86
    },
    {
        "name": "Medium",
        "tier": true,
        "id": 256,
        "count": 15
    },
    {
        "name": "High",
        "tier": true,
        "id": 257,
        "count": 150
    }
]

  1. Ensure you have your contractId query parameter.

  2. Build a new ChosenVersions object.

  3. POST the object to /crux/v1/device-posture/risk-assessment/chosen-versions/test{?contractId}.

  4. The operation responds with a RiskAssessment object.

List signal names

Returns a list of supported signal names for risk assessment. Unlisted signals are not supported for risk assessment.

GET /crux/v1/device-posture/risk-assessment/signal-names{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/signal-names?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: SignalName

Download schema: risk-assessment-signal-names.json

Response body:

[
    {
        "name": "anti-malware",
        "type": "select",
        "options": [],
        "mobile": false
    },
    {
        "name": "disk-encryption",
        "type": "boolean",
        "options": [
            {
                "value": true
            }
        ],
        "mobile": false
    },
    {
        "name": "firewall",
        "type": "boolean",
        "options": [
            {
                "value": true
            }
        ],
        "mobile": false
    },
    {
        "name": "dp-client-healthy",
        "type": "boolean",
        "options": [
            {
                "value": true
            }
        ],
        "mobile": null
    },
    {
        "name": "browser-version",
        "type": "mselect",
        "options": [
            {
                "name": "Latest",
                "value": "latest"
            },
            {
                "name": "Latest+",
                "value": "latest+"
            },
            {
                "name": "Custom",
                "value": "custom"
            }
        ],
        "mobile": false
    },
    {
        "name": "client-version",
        "type": "select",
        "options": [
            {
                "name": "Latest",
                "value": "latest"
            }
        ],
        "mobile": false
    },
    {
        "name": "os-version",
        "type": "mselect",
        "options": [
            {
                "name": "Latest",
                "value": "latest"
            },
            {
                "name": "Latest+",
                "value": "latest+"
            },
            {
                "name": "Up to date",
                "value": "up-to-date"
            },
            {
                "name": "Up to date+",
                "value": "up-to-date+"
            },
            {
                "name": "Custom",
                "value": "custom"
            }
        ],
        "mobile": null
    },
    {
        "name": "biometrics",
        "type": "boolean",
        "options": [
            {
                "value": true
            }
        ],
        "mobile": true
    },
    {
        "name": "jailbroken",
        "type": "boolean",
        "options": [
            {
                "value": false
            }
        ],
        "mobile": true
    },
    {
        "name": "screen-lock",
        "type": "boolean",
        "options": [
            {
                "value": true
            }
        ],
        "mobile": true
    },
    {
        "name": "certificate-profiles",
        "type": "mselect",
        "options": [],
        "mobile": false
    },
    {
        "name": "etp-threat",
        "type": "boolean",
        "options": [
            {
                "value": false
            }
        ],
        "mobile": false
    },
    {
        "name": "crowdstrike-healthy",
        "type": "boolean",
        "options": [
            {
                "value": true
            }
        ],
        "mobile": false
    },
    {
        "name": "mobile-client-version",
        "type": "mselect",
        "options": [
            {
                "name": "Latest",
                "value": "latest"
            },
            {
                "name": "Latest+",
                "value": "latest+"
            },
            {
                "name": "Custom",
                "value": "custom"
            }
        ],
        "mobile": true
    },
    {
        "name": "etp-client-status",
        "type": "boolean",
        "options": [
            {
                "value": true
            }
        ],
        "mobile": false
    },
    {
        "name": "cb-healthy",
        "type": "boolean",
        "options": [
            {
                "value": true
            }
        ],
        "mobile": false
    },
    {
        "name": "cb-policy",
        "type": "input",
        "options": [],
        "mobile": false
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/risk-assessment/signal-names{?contractId}.

  3. The operation responds with a SignalName object.

List client versions

Returns a list of supported client versions for risk assessment. Unlisted client versions are not supported for risk assessment.

GET /crux/v1/device-posture/risk-assessment/versions/client_version{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/versions/client_version?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: risk-assessment-client-versions.json

Response body:

[
    "1.0.0",
    "1.0.1",
    "1.1.0",
    "3.0.0",
    "1.5.0",
    "2.0.1",
    "1.0.8"
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/risk-assessment/versions/client_version{?contractId}.

  3. The operation responds with an array of client versions.

List risk tiers

Returns a list of supported risk tiers for risk assessment.

GET /crux/v1/device-posture/risk-assessment/tiers{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/tiers?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: RiskRule

Download schema: risk-assessment-rules.json

Response body:

[
    {
        "name": "Anti-malware",
        "rules": [
            {
                "os": [
                    "Windows"
                ],
                "signals": [
                    {
                        "name": "anti-malware",
                        "value": true
                    }
                ]
            }
        ],
        "version": "2018-12",
        "id": 1515
    },
    {
        "name": "Firewall",
        "rules": [
            {
                "os": [
                    "Windows"
                ],
                "signals": [
                    {
                        "name": "firewall",
                        "value": true
                    }
                ]
            }
        ],
        "version": "2018-12",
        "id": 1516
    },
    {
        "name": "EAAClient-latest",
        "rules": [
            {
                "os": [
                    "Mac OS X",
                    "Windows"
                ],
                "signals": [
                    {
                        "name": "client-version",
                        "value": "latest"
                    }
                ]
            }
        ],
        "version": "2018-12",
        "id": 1888
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/risk-assessment/tiers{?contractId}.

  3. The operation responds with a RiskRule object.

Get a risk tier

Returns details for a specific risk tier.

GET /crux/v1/device-posture/risk-assessment/tiers/{ruleId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/tiers/12345?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
ruleId Integer 12345 A unique identifier for this risk tier.
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: RiskRule

Download schema: risk-assessment-rule.json

Response body:

{
    "id": 12345,
    "name": "Low",
    "rank": 0,
    "version": "2018-12",
    "rules": [
        {
            "os": [
                "Mac OS X"
            ],
            "signals": [
                {
                    "name": "anti_malware",
                    "value": 1
                },
                {
                    "name": "disc_encryption",
                    "value": true
                },
                {
                    "name": "browser_version",
                    "value": [
                        "Latest",
                        "Custom"
                    ]
                }
            ]
        },
        {
            "os": [
                "Windows"
            ],
            "signals": [
                {
                    "name": "firewall",
                    "value": true
                },
                {
                    "name": "os_version",
                    "value": [
                        "Latest",
                        "Custom"
                    ]
                }
            ]
        }
    ]
}

  1. Run the List risk tiers operation and store the relevant ruleId.

  2. Ensure you have your contractId query parameter.

  3. Make a GET request to /crux/v1/device-posture/risk-assessment/tiers/{ruleId}{?contractId}.

  4. The operation responds with a RiskRule object.

Modify risk tier

Updates details for a specific risk tier.

PUT /crux/v1/device-posture/risk-assessment/tiers/{ruleId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/tiers/12345?contractId=F-EMGSGV

Content-Type: application/json

Object type: RiskRule

Download schema: risk-assessment-rule.json

Request body:

{
    "id": 12345,
    "name": "Low",
    "rank": 0,
    "version": "2018-12",
    "rules": [
        {
            "os": [
                "Mac OS X"
            ],
            "signals": [
                {
                    "name": "anti_malware",
                    "value": 1
                },
                {
                    "name": "disc_encryption",
                    "value": true
                },
                {
                    "name": "browser_version",
                    "value": [
                        "Latest",
                        "Custom"
                    ]
                }
            ]
        },
        {
            "os": [
                "Windows"
            ],
            "signals": [
                {
                    "name": "firewall",
                    "value": true
                },
                {
                    "name": "os_version",
                    "value": [
                        "Latest",
                        "Custom"
                    ]
                }
            ]
        }
    ]
}
Parameter Type Sample Description
URL path parameters
ruleId Integer 12345 A unique identifier for this risk tier.
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Ensure you have your contractId query parameter.

  2. Run the List risk tiers operation and store the relevant ruleId.

  3. Run the Get a risk tier operation and store the response object.

  4. Modify the RiskRule object.

  5. PUT the object to /crux/v1/device-posture/risk-assessment/tiers/{ruleId}{?contractId}.

List risk tags

Returns a list of supported risk tags for risk assessment.

GET /crux/v1/device-posture/risk-assessment/tags{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/tags?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: RiskRule

Download schema: risk-assessment-rules.json

Response body:

[
    {
        "name": "Low",
        "rank": 0,
        "rules": [
            {
                "os": [
                    "Mac OS X",
                    "Windows"
                ],
                "signals": [
                    {
                        "name": "anti-malware",
                        "value": 1
                    },
                    {
                        "name": "firewall",
                        "value": true
                    },
                    {
                        "name": "browser-version",
                        "value": [
                            "latest",
                            "custom",
                            "latest+"
                        ]
                    },
                    {
                        "name": "os-version",
                        "value": [
                            "latest",
                            "custom"
                        ]
                    },
                    {
                        "name": "dp-client-healthy",
                        "value": true
                    },
                    {
                        "name": "client-version",
                        "value": "latest"
                    },
                    {
                        "name": "disk-encryption",
                        "value": true
                    }
                ]
            }
        ],
        "version": "2019",
        "id": 159
    },
    {
        "name": "Medium",
        "rank": 50,
        "rules": [
            {
                "os": [
                    "Mac OS X"
                ],
                "signals": [
                    {
                        "name": "anti-malware",
                        "value": 1
                    },
                    {
                        "name": "os-version",
                        "value": [
                            "up-to-date",
                            "up-to-date+",
                            "custom"
                        ]
                    },
                    {
                        "name": "dp-client-healthy",
                        "value": true
                    },
                    {
                        "name": "firewall",
                        "value": true
                    }
                ]
            },
            {
                "os": [
                    "iOS"
                ],
                "signals": [
                    {
                        "name": "dp-client-healthy",
                        "value": true
                    },
                    {
                        "name": "biometrics",
                        "value": true
                    },
                    {
                        "name": "os-version",
                        "value": [
                            "latest",
                            "up-to-date"
                        ]
                    },
                    {
                        "name": "screen-lock",
                        "value": true
                    },
                    {
                        "name": "jailbroken",
                        "value": false
                    },
                    {
                        "name": "client-version",
                        "value": "latest"
                    }
                ]
            },
            {
                "os": [
                    "Windows"
                ],
                "signals": [
                    {
                        "name": "anti-malware",
                        "value": 1
                    },
                    {
                        "name": "os-version",
                        "value": [
                            "up-to-date",
                            "up-to-date+",
                            "custom"
                        ]
                    },
                    {
                        "name": "dp-client-healthy",
                        "value": true
                    },
                    {
                        "name": "firewall",
                        "value": true
                    }
                ]
            }
        ],
        "version": "2019",
        "id": 160
    },
    {
        "name": "High",
        "rank": 100,
        "rules": [],
        "version": "2019",
        "id": 161
    }
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/risk-assessment/tags{?contractId}.

  3. The operation responds with a RiskRule object.

Create risk tag

Creates a new risk tag.

POST /crux/v1/device-posture/risk-assessment/tags{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/tags?contractId=F-EMGSGV

Content-Type: application/json

Object type: RiskRule

Download schema: risk-assessment-rule.json

Request body:

{
    "id": 12345678,
    "name": "Stash",
    "version": "2018-12",
    "rules": [
        {
            "os": [
                "Mac OS X"
            ],
            "signals": [
                {
                    "name": "anti_malware",
                    "value": 1
                }
            ]
        },
        {
            "os": [
                "Windows"
            ],
            "signals": [
                {
                    "name": "firewall",
                    "value": true
                }
            ]
        }
    ]
}
Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 201

  1. Ensure you have your contractId query parameter.

  2. Build a new RiskRule object.

  3. POST the object to /crux/v1/device-posture/risk-assessment/tags{?contractId}.

Get a risk tag

Returns details for a specific risk tag.

GET /crux/v1/device-posture/risk-assessment/tags/{ruleId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/tags/12345?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
ruleId Integer 12345 A unique identifier for this risk tag.
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: RiskRule

Download schema: risk-assessment-rule.json

Response body:

{
    "id": 12345678,
    "name": "Stash",
    "version": "2018-12",
    "rules": [
        {
            "os": [
                "Mac OS X"
            ],
            "signals": [
                {
                    "name": "anti_malware",
                    "value": 1
                }
            ]
        },
        {
            "os": [
                "Windows"
            ],
            "signals": [
                {
                    "name": "firewall",
                    "value": true
                }
            ]
        }
    ]
}

  1. Run the List risk tiers operation and store the relevant ruleId.

  2. Ensure you have your contractId query parameter.

  3. Make a GET request to /crux/v1/device-posture/risk-assessment/tags/{ruleId}{?contractId}.

  4. The operation responds with a RiskRule object.

Modify a risk tag

Updates the details for a specific risk tag.

PUT /crux/v1/device-posture/risk-assessment/tags/{ruleId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/tags/12345?contractId=F-EMGSGV

Content-Type: application/json

Object type: RiskRule

Download schema: risk-assessment-rule.json

Request body:

{
    "id": 12345678,
    "name": "Stash",
    "version": "2018-12",
    "rules": [
        {
            "os": [
                "Mac OS X"
            ],
            "signals": [
                {
                    "name": "anti_malware",
                    "value": 1
                }
            ]
        },
        {
            "os": [
                "Windows"
            ],
            "signals": [
                {
                    "name": "firewall",
                    "value": true
                }
            ]
        }
    ]
}
Parameter Type Sample Description
URL path parameters
ruleId Integer 12345 A unique identifier for this risk tag.
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Run the List risk tiers operation and store the relevant ruleId.

  2. Ensure you have your contractId query parameter.

  3. Run the Get a risk tag operation and store the response object.

  4. Modify the RiskRule object.

  5. PUT the object to /crux/v1/device-posture/risk-assessment/tags/{ruleId}{?contractId}.

Delete a tag

Removes a tag from you Device Posture configuration.

DELETE /crux/v1/device-posture/risk-assessment/tags/{ruleId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/tags/12345?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
ruleId Integer 12345 A unique identifier for this risk tag.
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Run the List risk tiers operation and store the relevant ruleId.

  2. Ensure you have your contractId query parameter.

  3. Make a DELETE request to /crux/v1/device-posture/risk-assessment/tags/{ruleId}{?contractId}.

Test risk rule

Tests the specified risk rule against existing devices.

PUT /crux/v1/device-posture/risk-assessment/test/{ruleId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/test/12345?contractId=F-EMGSGV

Content-Type: application/json

Object type: RiskRule

Download schema: risk-assessment-rule.json

Request body:

{
    "id": 12345678,
    "name": "Stash",
    "version": "2018-12",
    "rules": [
        {
            "os": [
                "Mac OS X"
            ],
            "signals": [
                {
                    "name": "anti_malware",
                    "value": 1
                }
            ]
        },
        {
            "os": [
                "Windows"
            ],
            "signals": [
                {
                    "name": "firewall",
                    "value": true
                }
            ]
        }
    ]
}
Parameter Type Sample Description
URL path parameters
ruleId Integer 12345 A unique identifier for the risk rule.
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: RiskAssessment

Download schema: device-summary-risk-assessment.json

Response body:

[
    {
        "name": "Finance Tag",
        "tier": false,
        "id": 298,
        "count": 19
    },
    {
        "name": "Engineering Tag",
        "tier": false,
        "id": 299,
        "count": 57
    },
    {
        "name": "Low",
        "tier": true,
        "id": 255,
        "count": 86
    },
    {
        "name": "Medium",
        "tier": true,
        "id": 256,
        "count": 15
    },
    {
        "name": "High",
        "tier": true,
        "id": 257,
        "count": 150
    }
]

  1. Run the List risk tiers operation and store the relevant ruleId.

  2. Ensure you have your contractId query parameter.

  3. Run the Get a risk tag operation and store the response object.

  4. Modify the RiskRule object.

  5. PUT the object to /crux/v1/device-posture/risk-assessment/test/{ruleId}{?contractId}.

  6. The operation responds with a RiskAssessment object.

Get Carbon Black integration

Returns the details of a Carbon Black integration.

GET /crux/v1/device-posture/risk-assessment/partner/carbon-black{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/partner/carbon-black?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: CarbonBlack

Download schema: risk-assessment-partner-carbon-black.json

Response body:

{
    "enabled": true,
    "config": [
        {
            "name": "host",
            "value": "https://api-url.akam-integration.net"
        },
        {
            "name": "api-key",
            "value": "******"
        },
        {
            "name": "api-id",
            "value": "******"
        },
        {
            "name": "org-key",
            "value": "******"
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/risk-assessment/partner/carbon-black{?contractId}.

  3. The operation responds with a CarbonBlack object.

Modify Carbon Black integration

Updates the details for the Carbon Black integration.

PUT /crux/v1/device-posture/risk-assessment/partner/carbon-black{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/partner/carbon-black?contractId=F-EMGSGV

Content-Type: application/json

Object type: CarbonBlack

Download schema: risk-assessment-partner-carbon-black.json

Request body:

{
    "enabled": true,
    "config": [
        {
            "name": "host",
            "value": "https://api-url.akam-integration.net"
        },
        {
            "name": "api-key",
            "value": "D1KRAL27MQ7H1TYZTLARQN1M"
        },
        {
            "name": "api-id",
            "value": "BL8UVMYRUW"
        },
        {
            "name": "org-key",
            "value": "AQDRBL"
        }
    ]
}
Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Ensure you have your contractId query parameter.

  2. Run the Get Carbon Black integration operation and store the response object.

  3. Modify the CarbonBlack object.

  4. PUT the object to /crux/v1/device-posture/risk-assessment/partner/carbon-black{?contractId}.

Test Carbon Black integration

Tests a Carbon Black integration against your Device Posture configuration.

PUT /crux/v1/device-posture/risk-assessment/partner/carbon-black/test{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/partner/carbon-black/test?contractId=F-EMGSGV

Content-Type: application/json

Object type: CarbonBlack

Download schema: risk-assessment-partner-carbon-black.json

Request body:

{
    "enabled": true,
    "config": [
        {
            "name": "host",
            "value": "https://api-url.akam-integration.net"
        },
        {
            "name": "api-key",
            "value": "D1KRAL27MQ7H1TYZTLARQN1M"
        },
        {
            "name": "api-id",
            "value": "BL8UVMYRUW"
        },
        {
            "name": "org-key",
            "value": "AQDRBL"
        }
    ]
}
Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Ensure you have your contractId query parameter.

1.Run the Get Carbon Black integration operation and store the response object.

  1. Modify the CarbonBlack object.

  2. PUT the object to /crux/v1/device-posture/risk-assessment/partner/carbon-black/test{?contractId}.

Get CrowdStrike integration

Returns the details of a CrowdStrike integration.

GET /crux/v1/device-posture/risk-assessment/partner/crowdstrike{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/partner/crowdstrike?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: CrowdStrike

Download schema: risk-assessment-partner-crowdstrike.json

Response body:

{
    "enabled": true,
    "config": [
        {
            "name": "host",
            "value": "https://api-url.akam-integration.net"
        },
        {
            "name": "client-id",
            "value": "******"
        },
        {
            "name": "client-secret",
            "value": "******"
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/device-posture/risk-assessment/partner/crowdstrike{?contractId}.

  3. The operation responds with a CrowdStrike object.

Modify CrowdStrike integration

Updates the details for the CrowdStrike integration.

PUT /crux/v1/device-posture/risk-assessment/partner/crowdstrike{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/partner/crowdstrike?contractId=F-EMGSGV

Content-Type: application/json

Object type: CrowdStrike

Download schema: risk-assessment-partner-crowdstrike.json

Request body:

{
    "enabled": true,
    "config": [
        {
            "name": "host",
            "value": "https://api-url.akam-integration.net"
        },
        {
            "name": "client-id",
            "value": "h2ef5e3ecdf5400c990d7ba37d17drs2"
        },
        {
            "name": "client-secret",
            "value": "jX2an95ECPT1vWDl8IJXwGAdmxR0647yZrK3sfWp"
        }
    ]
}
Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Ensure you have your contractId query parameter.

  2. Run the Get CrowdStrike integration operation and store the response object.

  3. Modify the CrowdStrike object.

  4. PUT the object to /crux/v1/device-posture/risk-assessment/partner/crowdstrike{?contractId}.

Test CrowdStrike integration

Tests a CrowdStrike integration against your Device Posture configuration.

PUT /crux/v1/device-posture/risk-assessment/partner/crowdstrike/test{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/partner/crowdstrike/test?contractId=F-EMGSGV

Content-Type: application/json

Object type: CrowdStrike

Download schema: risk-assessment-partner-crowdstrike.json

Request body:

{
    "enabled": true,
    "config": [
        {
            "name": "host",
            "value": "https://api-url.akam-integration.net"
        },
        {
            "name": "client-id",
            "value": "h2ef5e3ecdf5400c990d7ba37d17drs2"
        },
        {
            "name": "client-secret",
            "value": "jX2an95ECPT1vWDl8IJXwGAdmxR0647yZrK3sfWp"
        }
    ]
}
Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Ensure you have your contractId query parameter.

1.Run the Get CrowdStrike integration operation and store the response object.

  1. Modify the CrowdStrike object.

  2. PUT the object to /crux/v1/device-posture/risk-assessment/partner/crowdstrike/test{?contractId}.

Get certificate profiles

Returns all the existing Certificate Profiles.

GET /crux/v1/device-posture/risk-assessment/certificate-profiles{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-profiles?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: risk-assessment-certificate-profile-list.json

Response body:

[
    {
        "name": "Certificate Profile Example 1",
        "caId": "5_hSGHsNzEsfUfsQ8-7yMo",
        "ocspId": "lLEPQoo3QyA-IHrRwy7I5w",
        "tpmAttested": false,
        "revocationStatus": true,
        "id": 1
    },
    {
        "name": "Certificate Profile Example 2",
        "caId": "5_hSGHsNzEsfUfsQ8-7yMo",
        "ocspId": "llwoyIHyEQ7IRQPo-5LrA3w",
        "tpmAttested": true,
        "revocationStatus": true,
        "id": 2
    }
]

Create certificate profile

Creates a new Certificate Profile.

POST /crux/v1/device-posture/risk-assessment/certificate-profiles{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-profiles?contractId=F-EMGSGV

Content-Type: application/json

Download schema: risk-assessment-certificate-profile-with-id.json

Request body:

{
    "name": "Certificate Profile Example",
    "revocationStatus": true,
    "tpmAttested": true,
    "caId": "5_hSGHsNzEsfUfsQ8-7yMo",
    "ocspId": "lLEPQoo3QyA-IHrRwy7I5w"
}
Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 201 application/json

Download schema: risk-assessment-certificate-profile-id.json

Response body:

{
    "id": 1
}

Get certificate profile

Get a certificate profile by its id.

GET /crux/v1/device-posture/risk-assessment/certificate-profiles/{certificateProfileId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-profiles/123?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
certificateProfileId Integer 123 A unique identifier for the certificate profile.
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: risk-assessment-certificate-profile-with-id.json

Response body:

{
    "name": "Certificate Profile Example",
    "caId": "BQWK7x1cdaiTKC-9cfEANu",
    "ocspId": "lLEPQoo3QyA-IHrRwy7I5w",
    "tpmAttested": true,
    "revocationStatus": true,
    "id": 1
}

Update certificate profile

Update a certificate profile.

PUT /crux/v1/device-posture/risk-assessment/certificate-profiles/{certificateProfileId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-profiles/123?contractId=F-EMGSGV

Content-Type: application/json

Download schema: risk-assessment-certificate-profile-with-id.json

Request body:

{
    "name": "Certificate Profile Example",
    "revocationStatus": true,
    "tpmAttested": true,
    "caId": "5_hSGHsNzEsfUfsQ8-7yMo",
    "ocspId": "lLEPQoo3QyA-IHrRwy7I5w"
}
Parameter Type Sample Description
URL path parameters
certificateProfileId Integer 123 A unique identifier for the certificate profile.
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

Delete certificate profile

Delete a certificate profile.

DELETE /crux/v1/device-posture/risk-assessment/certificate-profiles/{certificateProfileId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-profiles/123?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
certificateProfileId Integer 123 A unique identifier for the certificate profile.
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

Get CA and OCSP information

Get CA and OCSP information that can be used in Certificate Profiles.

GET /crux/v1/device-posture/risk-assessment/ca-ocsp{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/ca-ocsp?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: risk-assessment-all-ca-oscp.json

Response body:

{
    "ca": [
        {
            "id": "BQWK7x1cdaiTKC-9cfEANu",
            "name": "Example CA 1"
        },
        {
            "id": "glq7Av4Vq2TT--3tDp9Mej",
            "name": "Example CA 2"
        },
        {
            "id": "5_hSGHsNzEsfUfsQ8-7yMo",
            "name": "Example CA 3"
        }
    ],
    "ocsp": [
        {
            "id": "rOe8GyLtRuWSRkPWqHz6AA",
            "name": "OCSP Example 1"
        },
        {
            "id": "wp9edkDYWrruqRULe71ALg",
            "name": "OCSP Example 2"
        },
        {
            "id": "lLEPQoo3QyA-IHrRwy7I5w",
            "name": "OCSP Example 3"
        },
        {
            "id": "Qjrv0v4mhWesNnYbTAnJbd",
            "name": "OCSP Example 4"
        }
    ]
}

Get CA information

Get CA usage information.

GET /crux/v1/device-posture/risk-assessment/certificate-usage/ca{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-usage/ca?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: risk-assessment-ca-usage.json

Response body:

{
    "in_use": true,
    "description": "Used in Certificate Profile Example"
}

Get OCSP information

Get OCSP usage information.

GET /crux/v1/device-posture/risk-assessment/certificate-usage/ocsp{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-usage/ocsp?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: risk-assessment-ocsp-usage.json

Response body:

{
    "in_use": true,
    "description": "Used in Certificate Profile Example"
}

List anti-malware profiles

Returns all the existing Anti-Malware Profiles.

GET /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: risk-assessment-anti-malware-profile-list.json

Response body:

[
    {
        "name": "Any Vendor",
        "windows": "Any Vendor",
        "mac": "Any Vendor",
        "id": 1
    },
    {
        "name": "Anti-Malware Profile Example 1",
        "windows": "Avast",
        "mac": "Avast",
        "id": 2
    },
    {
        "name": "Anti-Malware Profile Example 2",
        "windows": "McAfee",
        "mac": "N/A",
        "id": 3
    }
]

Create an anti-malware profile

Creates a new Anti-Malware Profile.

POST /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles?contractId=F-EMGSGV

Content-Type: application/json

Download schema: risk-assessment-anti-malware-profile-with-id.json

Request body:

{
    "name": "Anti-Malware Profile Example 1",
    "windows": "Avast",
    "mac": "Avast"
}
Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 201 application/json

Download schema: risk-assessment-anti-malware-profile-id.json

Response body:

{
    "id": 2
}

Get an anti-malware profile

Get an Anti-Malware Profile by its id.

GET /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/{antiMalwareProfileId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/{antiMalwareProfileId}?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: risk-assessment-anti-malware-profile-with-id.json

Response body:

{
    "name": "Anti-Malware Profile Example 1",
    "windows": "Avast",
    "mac": "Avast",
    "id": 2
}

Update an anti-malware profile

Update an Anti-Malware Profile.

PUT /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/{antiMalwareProfileId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/{antiMalwareProfileId}?contractId=F-EMGSGV

Content-Type: application/json

Download schema: risk-assessment-anti-malware-profile-with-id.json

Request body:

{
    "name": "Anti-Malware Profile Example 1",
    "windows": "Avast",
    "mac": "Avast"
}
Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

Delete an anti-malware profile

Delete an Anti-Malware Profile.

DELETE /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/{antiMalwareProfileId}{?contractId}

Sample: /crux/v1/device-posture/risk-assessment/certificate-usage/anti-malware-profiles/{antiMalwareProfileId}?contractId=F-EMGSGV

Parameter Type Sample Description
Optional query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

List IDPs

Returns a list of IDPs.

GET /crux/v1/mgmt-pop/idp{?contractId,offset,limit,expand}

Sample: /crux/v1/mgmt-pop/idp?contractId=F-EMGSGV&offset=10&limit=30&expand=true

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: Idp

Download schema: idps.json

Response body:

{
    "meta": {
        "previous": null,
        "total_count": 2,
        "offset": 0,
        "limit": 20,
        "next": null
    },
    "objects": [
        {
            "status": 1,
            "domain_suffix": "login.stage.sohacloud.net",
            "directory_count": 0,
            "max_login_failures": 5,
            "popName": "us-west-coast-1",
            "default_language": "english",
            "pop": "dDOXO4w0QYGdsKq4zC-YOg",
            "logo": null,
            "login_cname": null,
            "enable_access_client": false,
            "description": null,
            "background_image": null,
            "favicon_image": null,
            "login_suffix": "login.stage.sohacloud.net",
            "trust_expiry": 365,
            "auth_response_encrypt": false,
            "company_id": "regv3ds",
            "logout_url": null,
            "idp_operational": 1,
            "iwa_keytab": [],
            "uuid_url": "ZVZU1zvGRieOyLibfcKc-A",
            "app_count": 0,
            "ocsp": null,
            "client_cert": null,
            "metadata": null,
            "auth_request_signed": false,
            "saml_url": null,
            "login_dialin_server": null,
            "background_image_file_name": null,
            "logo_file_name": null,
            "login_host": null,
            "client_principle_name": "<sAMAccountName>",
            "dns_added": false,
            "enable_mfa": false,
            "idp_deployed": false,
            "idp_status": 1,
            "directory_list": [],
            "lockout_interval": 1,
            "login_domain": 2,
            "resource": "idp",
            "name": "IDP",
            "settings": {
                "portal_logo_width": "256",
                "g2o_enabled": "false",
                "idp_iwa_onpremise_path": "false",
                "single_logout_supported": "false",
                "idp_iwa_check_prem": "false",
                "portal_logo_height": "256",
                "eaac_bin_base_url": "",
                "trusted_network_searchdomain": "",
                "trusted_network_enable": "false",
                "force_login": "true",
                "idp_iwa_check_ua": "",
                "idp_iwa_check_cert": "false",
                "g2o_nonce": null,
                "client_cert_auth_validation_responder": "",
                "portal_title_box": "false",
                "portal_background": "./assets/img/body-bg.png",
                "form_text": {
                    "user_placeholder": "Username"
                },
                "client_cert_identity_username": "false",
                "enable_favrt": "false",
                "force_login_after": 7200,
                "client_cert_auth_onboard_criteria": "nocert",
                "captive_portal": "true",
                "enable_oidc_saml_bridging": "false",
                "idp_iwa_check_os": "",
                "xframe_urls": null,
                "client_cert_auth": "false",
                "portal_terms_box": "false",
                "persistent_cookie": "true",
                "portal_theme": "bubblewrapp",
                "client_cert_renewal": "",
                "enable_authorization": "false",
                "g2o_key": null,
                "enable_device_posture": "false",
                "login_terms": null,
                "infra_prem_gateways": [],
                "portal_logo_url": "./assets/img/logo.png",
                "client_cert_auth_onboard_url": "",
                "client_cert_auth_validation_method": null,
                "idp_cdn_enabled": "false",
                "portal_new_user_signup_url": "",
                "login_title": null,
                "idp_iwa_krb5_spn": "",
                "xframe_options": "false",
                "portal_change_password_url": "",
                "idp_iwa_mode": "off",
                "group_attr_name": "Group",
                "trusted_network_hostname_ip": "",
                "client_cert_exp_warn_interval": 0,
                "client_cert_user_param": ""
            },
            "idp_type": 2,
            "multilang_fields": null,
            "created_at": "2019-07-08T10:31:20.007541",
            "modified_at": "2019-07-08T10:31:20.139938",
            "cookie_expiry": 120,
            "attribute_map": {},
            "helpdesk_email": "contact@mail.com",
            "cert": null,
            "login_lockout": "off",
            "domains": [],
            "mfa_settings": {
                "duo_secret_key": "",
                "mfa_email_preset": "false",
                "mfa_pci_dss": "false",
                "mfa_sms_preset": "false",
                "mfa_factor_sms": "true",
                "mfa_factor_duo": "false",
                "mfa_sms_immutable": "false",
                "mfa_factor_email": "true",
                "mfa_email_immutable": "false",
                "mfa_factor_totp": "false",
                "duo_akey": "",
                "duo_umap": "user.email",
                "duo_api_hostname": "",
                "duo_integration_key": "",
                "idp_notification_org_name": ""
            },
            "resource_uri": {
                "href": "/api/v1/idp/ZVZU1zvGRieOyLibfcKc-A",
                "idp": "/api/v1/idp/ZVZU1zvGRieOyLibfcKc-A/idp/"
            }
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. For pagination, set offset the number of members to skip in the object list.

  3. For a pagination, set limit to specify the maximum number of members to return in the response.

  4. Optionally, set expand to true to include additional members in the response.

  5. Make a GET request to /crux/v1/mgmt-pop/idp{?contractId,offset,limit,expand}.

  6. The operation responds with a Idp object.

Create an IDP

Create a new IDP

POST /crux/v1/mgmt-pop/idp{?contractId}

Sample: /crux/v1/mgmt-pop/idp?contractId=F-EMGSGV

Content-Type: application/json

Object type: Idp

Download schema: idp.json

Request body:

{
    "idp_type": 2,
    "name": "IDP"
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Idp

Download schema: idp.json

Response body:

{
    "app_count": 0,
    "attribute_map": {},
    "auth_request_signed": false,
    "auth_response_encrypt": false,
    "background_image": null,
    "background_image_file_name": null,
    "cert": null,
    "client_cert": null,
    "client_principle_name": "<sAMAccountName>",
    "company_id": "regv3ds",
    "cookie_expiry": 120,
    "created_at": "2019-07-08T10:31:20.007541",
    "default_language": "english",
    "description": null,
    "directory_count": 0,
    "directory_list": [],
    "dns_added": false,
    "domain_suffix": "login.stage.sohacloud.net",
    "domains": [],
    "enable_access_client": false,
    "enable_mfa": false,
    "favicon_image": null,
    "helpdesk_email": "contact@mail.com",
    "idp_deployed": false,
    "idp_operational": 1,
    "idp_status": 1,
    "idp_type": 2,
    "iwa_keytab": [],
    "lockout_interval": 1,
    "login_cname": null,
    "login_dialin_server": null,
    "login_domain": 2,
    "login_host": null,
    "login_lockout": "off",
    "login_suffix": "login.stage.sohacloud.net",
    "logo": null,
    "logo_file_name": null,
    "logout_url": null,
    "max_login_failures": 5,
    "metadata": null,
    "mfa_settings": {
        "duo_akey": "",
        "duo_api_hostname": "",
        "duo_integration_key": "",
        "duo_secret_key": "",
        "duo_umap": "user.email",
        "idp_notification_org_name": "",
        "mfa_email_immutable": "false",
        "mfa_email_preset": "false",
        "mfa_factor_duo": "false",
        "mfa_factor_email": "true",
        "mfa_factor_sms": "true",
        "mfa_factor_totp": "false",
        "mfa_pci_dss": "false",
        "mfa_sms_immutable": "false",
        "mfa_sms_preset": "false"
    },
    "modified_at": "2019-07-08T10:31:20.139938",
    "multilang_fields": null,
    "name": "IDP",
    "ocsp": null,
    "pop": "dDOXO4w0QYGdsKq4zC-YOg",
    "popName": "us-west-coast-1",
    "resource": "idp",
    "resource_uri": {
        "href": "/api/v1/idp/ZVZU1zvGRieOyLibfcKc-A",
        "idp": "/api/v1/idp/ZVZU1zvGRieOyLibfcKc-A/idp/"
    },
    "saml_url": null,
    "settings": {
        "captive_portal": "true",
        "client_cert_auth": "false",
        "client_cert_auth_onboard_criteria": "nocert",
        "client_cert_auth_onboard_url": "",
        "client_cert_auth_validation_method": null,
        "client_cert_auth_validation_responder": "",
        "client_cert_exp_warn_interval": 0,
        "client_cert_identity_username": "false",
        "client_cert_renewal": "",
        "client_cert_user_param": "",
        "eaac_bin_base_url": "",
        "enable_authorization": "false",
        "enable_device_posture": "false",
        "enable_favrt": "false",
        "enable_oidc_saml_bridging": "false",
        "force_login": "true",
        "force_login_after": 7200,
        "form_text": {
            "user_placeholder": "Username"
        },
        "g2o_enabled": "false",
        "g2o_key": null,
        "g2o_nonce": null,
        "group_attr_name": "Group",
        "idp_cdn_enabled": "false",
        "idp_iwa_check_cert": "false",
        "idp_iwa_check_os": "",
        "idp_iwa_check_prem": "false",
        "idp_iwa_check_ua": "",
        "idp_iwa_krb5_spn": "",
        "idp_iwa_mode": "off",
        "idp_iwa_onpremise_path": "false",
        "infra_prem_gateways": [],
        "login_terms": null,
        "login_title": null,
        "persistent_cookie": "true",
        "portal_background": "./assets/img/body-bg.png",
        "portal_change_password_url": "",
        "portal_logo_height": "256",
        "portal_logo_url": "./assets/img/logo.png",
        "portal_logo_width": "256",
        "portal_new_user_signup_url": "",
        "portal_terms_box": "false",
        "portal_theme": "bubblewrapp",
        "portal_title_box": "false",
        "single_logout_supported": "false",
        "trusted_network_enable": "false",
        "trusted_network_hostname_ip": "",
        "trusted_network_searchdomain": "",
        "xframe_options": "false",
        "xframe_urls": null
    },
    "status": 1,
    "trust_expiry": 365,
    "uuid_url": "ZVZU1zvGRieOyLibfcKc-A"
}

  1. Ensure you have your contractId query parameter.

  2. Build a new Idp object.

  3. POST the object to /crux/v1/mgmt-pop/idp{?contractId}.

  4. The operation responds with a Idp object.

Get an IDP

Returns a single IDP.

GET /crux/v1/mgmt-pop/idp/{idp_id}{?contractId}

Sample: /crux/v1/mgmt-pop/idp/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
idp_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each IDP.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Idp

Download schema: idp.json

Response body:

{
    "status": 4,
    "domain_suffix": "login.stage.sohacloud.net",
    "directory_count": 1,
    "max_login_failures": 5,
    "popName": "us-west-coast-1",
    "default_language": "english",
    "pop": "dDOXO4w0QYGdsKq4zC-YOg",
    "logo": "",
    "login_cname": "regv3ds.login.stage.sohacloud.net",
    "enable_access_client": true,
    "description": null,
    "background_image": "",
    "favicon_image": null,
    "login_suffix": "login.stage.sohacloud.net",
    "trust_expiry": 365,
    "auth_response_encrypt": false,
    "company_id": "regv3ds",
    "logout_url": "",
    "oidcclients": "vD2FCQeaRlieatrLStp3xw",
    "idp_operational": 1,
    "iwa_keytab": [],
    "uuid_url": "6IlO8WcjS3iOgWYi55bMOw",
    "app_count": 2,
    "ocsp": null,
    "client_cert": null,
    "metadata": null,
    "auth_request_signed": false,
    "saml_url": "",
    "login_dialin_server": "regv3ds.login.dialin.stage.sohacloud.net",
    "background_image_file_name": "",
    "logo_file_name": "",
    "login_host": "regv3ds",
    "client_principle_name": "<sAMAccountName>",
    "dns_added": false,
    "enable_mfa": false,
    "idp_deployed": false,
    "idp_status": 4,
    "directory_list": [
        "GbIfrXwtTKaqBrXD0ZkGBA"
    ],
    "lockout_interval": 1,
    "login_domain": 2,
    "resource": "idp",
    "name": "regv3ds",
    "settings": {
        "portal_logo_width": "256",
        "g2o_enabled": "false",
        "idp_iwa_onpremise_path": "false",
        "single_logout_supported": "false",
        "portal_logo_url": "./assets/img/logo.png",
        "portal_logo_height": "256",
        "eaac_bin_base_url": "",
        "force_login": "true",
        "idp_iwa_check_ua": "",
        "idp_iwa_check_cert": "false",
        "g2o_nonce": null,
        "client_cert_auth_validation_responder": "",
        "portal_title_box": "false",
        "portal_background": "./assets/img/body-bg.png",
        "form_text": {
            "user_placeholder": "Username"
        },
        "client_cert_identity_username": "false",
        "enable_favrt": "false",
        "force_login_after": "7200",
        "client_cert_auth_onboard_criteria": "nocert",
        "idp_iwa_check_prem": "false",
        "enable_oidc_saml_bridging": "false",
        "idp_iwa_check_os": "",
        "xframe_urls": [
            {
                "url": ""
            }
        ],
        "client_cert_auth": "false",
        "portal_terms_box": "false",
        "persistent_cookie": "true",
        "portal_theme": "bubblewrapp",
        "client_cert_renewal": "",
        "enable_authorization": "false",
        "g2o_key": null,
        "enable_device_posture": "false",
        "login_terms": null,
        "infra_prem_gateways": [
            {
                "value": ""
            }
        ],
        "client_cert_auth_onboard_url": "",
        "client_cert_auth_validation_method": null,
        "portal_new_user_signup_url": "",
        "login_title": null,
        "idp_iwa_krb5_spn": "",
        "xframe_options": "false",
        "portal_change_password_url": "",
        "idp_iwa_mode": "off",
        "group_attr_name": "Group",
        "client_cert_exp_warn_interval": 0,
        "client_cert_user_param": ""
    },
    "idp_type": 1,
    "multilang_fields": null,
    "created_at": "2019-03-20T10:28:23.080189",
    "modified_at": "2019-05-28T08:05:43.330112",
    "cookie_expiry": 120,
    "attribute_map": {},
    "helpdesk_email": "contact@mail.com",
    "cert": null,
    "login_lockout": "off",
    "domains": [],
    "mfa_settings": {
        "duo_secret_key": "",
        "mfa_email_preset": "false",
        "mfa_pci_dss": "false",
        "mfa_sms_preset": "false",
        "mfa_factor_sms": "true",
        "mfa_factor_duo": "false",
        "mfa_sms_immutable": "false",
        "mfa_factor_email": "true",
        "mfa_email_immutable": "false",
        "mfa_factor_totp": "false",
        "duo_akey": "",
        "duo_umap": "user.email",
        "duo_api_hostname": "",
        "duo_integration_key": "",
        "idp_notification_org_name": ""
    },
    "resource_uri": {
        "href": "/api/v1/idp/6IlO8WcjS3iOgWYi55bMOw",
        "idp": "/api/v1/idp/6IlO8WcjS3iOgWYi55bMOw/idp/"
    }
}

  1. Run the List IDPs operation and store the relevant IDP id.

  2. Optionally, set expand to true to include additional members in the response.

  3. Make a GET request to /crux/v1/mgmt-pop/idp/{id}{?expand}.

  4. The operation responds with a Idp object.

Modify an IDP

Updates an existing IDP.

PUT /crux/v1/mgmt-pop/idp/{idp_id}{?contractId}

Sample: /crux/v1/mgmt-pop/idp/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
idp_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each IDP.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Idp

Download schema: idp.json

Response body:

{
    "status": 4,
    "domain_suffix": "login.stage.sohacloud.net",
    "directory_count": 1,
    "max_login_failures": 5,
    "popName": "us-west-coast-1",
    "default_language": "english",
    "pop": "dDOXO4w0QYGdsKq4zC-YOg",
    "logo": "",
    "login_cname": "regv3ds.login.stage.sohacloud.net",
    "enable_access_client": true,
    "description": null,
    "background_image": "",
    "favicon_image": null,
    "login_suffix": "login.stage.sohacloud.net",
    "trust_expiry": 365,
    "auth_response_encrypt": false,
    "company_id": "regv3ds",
    "logout_url": "",
    "oidcclients": "vD2FCQeaRlieatrLStp3xw",
    "idp_operational": 1,
    "iwa_keytab": [],
    "uuid_url": "6IlO8WcjS3iOgWYi55bMOw",
    "app_count": 2,
    "ocsp": null,
    "client_cert": null,
    "metadata": null,
    "auth_request_signed": false,
    "saml_url": "",
    "login_dialin_server": "regv3ds.login.dialin.stage.sohacloud.net",
    "background_image_file_name": "",
    "logo_file_name": "",
    "login_host": "regv3ds",
    "client_principle_name": "<sAMAccountName>",
    "dns_added": false,
    "enable_mfa": false,
    "idp_deployed": false,
    "idp_status": 4,
    "directory_list": [
        "GbIfrXwtTKaqBrXD0ZkGBA"
    ],
    "lockout_interval": 1,
    "login_domain": 2,
    "resource": "idp",
    "name": "regv3ds",
    "settings": {
        "portal_logo_width": "256",
        "g2o_enabled": "false",
        "idp_iwa_onpremise_path": "false",
        "single_logout_supported": "false",
        "portal_logo_url": "./assets/img/logo.png",
        "portal_logo_height": "256",
        "eaac_bin_base_url": "",
        "force_login": "true",
        "idp_iwa_check_ua": "",
        "idp_iwa_check_cert": "false",
        "g2o_nonce": null,
        "client_cert_auth_validation_responder": "",
        "portal_title_box": "false",
        "portal_background": "./assets/img/body-bg.png",
        "form_text": {
            "user_placeholder": "Username"
        },
        "client_cert_identity_username": "false",
        "enable_favrt": "false",
        "force_login_after": "7200",
        "client_cert_auth_onboard_criteria": "nocert",
        "idp_iwa_check_prem": "false",
        "enable_oidc_saml_bridging": "false",
        "idp_iwa_check_os": "",
        "xframe_urls": [
            {
                "url": ""
            }
        ],
        "client_cert_auth": "false",
        "portal_terms_box": "false",
        "persistent_cookie": "true",
        "portal_theme": "bubblewrapp",
        "client_cert_renewal": "",
        "enable_authorization": "false",
        "g2o_key": null,
        "enable_device_posture": "false",
        "login_terms": null,
        "infra_prem_gateways": [
            {
                "value": ""
            }
        ],
        "client_cert_auth_onboard_url": "",
        "client_cert_auth_validation_method": null,
        "portal_new_user_signup_url": "",
        "login_title": null,
        "idp_iwa_krb5_spn": "",
        "xframe_options": "false",
        "portal_change_password_url": "",
        "idp_iwa_mode": "off",
        "group_attr_name": "Group",
        "client_cert_exp_warn_interval": 0,
        "client_cert_user_param": ""
    },
    "idp_type": 1,
    "multilang_fields": null,
    "created_at": "2019-03-20T10:28:23.080189",
    "modified_at": "2019-05-28T08:05:43.330112",
    "cookie_expiry": 120,
    "attribute_map": {},
    "helpdesk_email": "contact@mail.com",
    "cert": null,
    "login_lockout": "off",
    "domains": [],
    "mfa_settings": {
        "duo_secret_key": "",
        "mfa_email_preset": "false",
        "mfa_pci_dss": "false",
        "mfa_sms_preset": "false",
        "mfa_factor_sms": "true",
        "mfa_factor_duo": "false",
        "mfa_sms_immutable": "false",
        "mfa_factor_email": "true",
        "mfa_email_immutable": "false",
        "mfa_factor_totp": "false",
        "duo_akey": "",
        "duo_umap": "user.email",
        "duo_api_hostname": "",
        "duo_integration_key": "",
        "idp_notification_org_name": ""
    },
    "resource_uri": {
        "href": "/api/v1/idp/6IlO8WcjS3iOgWYi55bMOw",
        "idp": "/api/v1/idp/6IlO8WcjS3iOgWYi55bMOw/idp/"
    }
}

  1. Run the List IDPs operation and store the relevant IDP id.

  2. Run the Get an IDP operation and store the response object.

  3. Modify the IDP object.

  4. Make a PUT request to /crux/v1/mgmt-pop/idp/{id}.

  5. The operation responds with a Idp object.

Delete an IDP

Deletes an existing IDP.

DELETE /crux/v1/mgmt-pop/idp/{idp_id}{?contractId}

Sample: /crux/v1/mgmt-pop/idp/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
idp_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each IDP.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Run the List IDPs operation and store the relevant IDP id.

  2. Make a DELETE request to /crux/v1/mgmt-pop/idp/{id}.

Get an IDP directory membership

Retrieves associated directory membership of an IDP.

GET /crux/v1/mgmt-pop/idp/{idp_id}/directories_membership{?contractId}

Sample: /crux/v1/mgmt-pop/idp/ojxkXzwyQZiBkoRee0XcnA/directories_membership?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
idp_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each IDP.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: idp-directories-membership.json

Response body:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "directory": {
                "directory_uuid_url": "GbIfrXwtTKaqBrXD0ZkGBA",
                "name": "Cloud Directory"
            },
            "idp": {
                "idp_uuid_url": "6IlO8WcjS3iOgWYi55bMOw",
                "name": "regv3ds"
            },
            "resource": "idpdirectory",
            "resource_uri": {
                "directory": "/api/v1/directory/GbIfrXwtTKaqBrXD0ZkGBA",
                "href": "/api/v1/idpdirectory/hp7EQTGxThCzRmWFNsd-1A",
                "idp": "/api/v1/idp/6IlO8WcjS3iOgWYi55bMOw"
            },
            "uuid_url": "hp7EQTGxThCzRmWFNsd-1A"
        }
    ]
}

  1. Run the List IDPs operation and store the relevant IDP id.

  2. Make a GET request to /crux/v1/mgmt-pop/idp/{id}/directories_membership.

  3. The operation responds with an array of directory memberships for the IDP.

Get an IDP status

Retrieves the current IDP status.

GET /crux/v1/mgmt-pop/idp/{idp_id}/status{?contractId}

Sample: /crux/v1/mgmt-pop/idp/ojxkXzwyQZiBkoRee0XcnA/status?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
idp_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each IDP.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Response body:

{
    "login_host_dns_status": 6,
    "login_pop_status": 2,
    "login_cert_status": 6,
    "login_directories_status": 6,
    "login_saml_status": 2,
    "login_oidc_status": 2,
    "idp_deployed": true,
    "manual_override": false
}

  1. Run the List IDPs operation and store the relevant IDP id.

  2. Make a GET request to /crux/v1/mgmt-pop/idp/{id}/status.

  3. The operation responds with a IDP object with the status key promoted to the top.

Upload metadata of an IDP

Uploads metadata to add or update to the IDP.

POST /crux/v1/mgmt-pop/idp/{idp_id}/metadata{?contractId}

Sample: /crux/v1/mgmt-pop/idp/ojxkXzwyQZiBkoRee0XcnA/metadata?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
idp_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each IDP.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Run the List IDPs operation and store the relevant IDP id.

  2. Make a POST request to /crux/v1/mgmt-pop/idp/{id}/metadata.

Enable ghost to origin (G2O) for an IDP

Enable G2O for an IDP.

POST /crux/v1/mgmt-pop/idp/{idp_id}/g2o{?contractId}

Sample: /crux/v1/mgmt-pop/idp/ojxkXzwyQZiBkoRee0XcnA/g2o?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
idp_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each IDP.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Response body:

{
    "g2o_key": "2557853b61e3962e2e0b8646c9a7794f",
    "g2o_enabled": "true",
    "g2o_nonce": "0862646f"
}

  1. Run the List IDPs operation and store the relevant IDP id.

  2. Make a POST request to /crux/v1/mgmt-pop/idp/{id}/g2o.

  3. The operation responds with a G2O object.

List IDP directories

Gets a list of IDP directories.

GET /crux/v1/mgmt-pop/idpdirectory{?contractId,offset,limit}

Sample: /crux/v1/mgmt-pop/idpdirectory?contractId=F-EMGSGV&offset=10&limit=30

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: IdpDirectory

Download schema: idpdirectories.json

Response body:

{
    "meta": {
        "previous": null,
        "total_count": 5,
        "offset": 0,
        "limit": 1000,
        "next": null
    },
    "objects": [
        {
            "mfa": "off",
            "ou_filter": null,
            "user_display_name": "displayName",
            "user_search_filter": "(&(objectClass=user)(objectClass=person))",
            "group_object_classes": [
                "group",
                "groupOfNames"
            ],
            "group_name": "cn",
            "password_change_allow": false,
            "agents": [],
            "group_search_filter": "(objectClass=group)",
            "group_base_dn": null,
            "directory_status": 3,
            "port": 636,
            "group_token": "primaryGroupToken",
            "ou_attr": null,
            "sync_interval": 21600,
            "user_count": 11,
            "service": 6,
            "resource_uri": {
                "href": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
                "users": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg/users/",
                "groups": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg/groups/"
            },
            "signed_request": false,
            "sync_state": 1,
            "root_dn": null,
            "auth_response_encrypt": false,
            "company_id": null,
            "logout_url": null,
            "user_memberof": "memberOf",
            "nameidformat": null,
            "uuid_url": "U59wJq3dQNuanDH8VMc1Gg",
            "api_key": null,
            "user_fname": "givenName",
            "conf_state": 1,
            "metadata": null,
            "auth_request_signed": false,
            "admin_user": null,
            "user_samaccountname": "sAMAccountName",
            "description": null,
            "password_policy_default": "",
            "group_members": "member",
            "user_upn": "userPrincipalName",
            "dialin_sni": null,
            "ssl": true,
            "group_count": 11,
            "global_catalog": false,
            "password_expire_warn_threshold": 0,
            "kerb_realms": [],
            "ou_object_classes": [
                "organizationalUnit"
            ],
            "user_memberuid": "memberUid",
            "user_lname": "sn",
            "chase_referral": false,
            "schema_attributes": "{}",
            "password_complexity_message": null,
            "password_change_threshold": 0,
            "resource": "directories",
            "name": "Cloud Directory",
            "user_phone_num": "telephoneNumber",
            "user_base_dn": null,
            "created_at": "2017-01-04T14:58:29.884927",
            "server_cert_validate": true,
            "modified_at": "2018-05-18T04:37:13.487706",
            "host": null,
            "attribute_map": {
                "user.phoneNumber": "cloud.phone_number",
                "user.countryCode": "cloud.country_code",
                "user.email": "cloud.email",
                "user.lastName": "cloud.last_name",
                "user.firstName": "cloud.first_name",
                "user.netbios": "cloud.netbios",
                "user.persistentId": "cloud.uuid",
                "user.samAccountName": "cloud.samaccountname",
                "user.userPrincipleName": "cloud.user_principle_name"
            },
            "last_sync": "2017-01-04T14:58:29.885037",
            "user_object_classes": [
                "person",
                "organizationalPerson",
                "user",
                "inetOrgPerson"
            ],
            "cname": null,
            "status": 1,
            "domains": [],
            "user_principal": "sAMAccountName",
            "password_filter": {},
            "directory_type": 1,
            "user_email": "mail",
            "password_reset_allow": false
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. Optionally, set the offset query parameter.

  3. Optionally, set the limit query parameter.

  4. Make a GET request to /crux/v1/mgmt-pop/idpdirectory{?contractId,offset,limit}.

  5. The operation responds with a IdpDirectory object.

Create an IDP directory

Creates a new IDP directory.

POST /crux/v1/mgmt-pop/idpdirectory{?contractId}

Sample: /crux/v1/mgmt-pop/idpdirectory?contractId=F-EMGSGV

Content-Type: application/json

Request body:

{
    "idp": "xz_HqmAdSNeSnoCWss9Phg",
    "directories": [
        "AtjdKbXqQFmp0TDD9TtaHg"
    ]
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: IdpDirectory

Download schema: idpdirectory.json

Response body:

[
    {
        "directory": "AtjdKbXqQFmp0TDD9TtaHg",
        "resource": "idpdirectory",
        "resource_uri": {
            "directory": "/api/v1/directory/AtjdKbXqQFmp0TDD9TtaHg",
            "href": "/api/v1/idpdirectory/dDg9SKXXQgugaNCB3x8nrg",
            "idp": "/api/v1/idp/xz_HqmAdSNeSnoCWss9Phg"
        },
        "uuid_url": "dDg9SKXXQgugaNCB3x8nrg"
    }
]

  1. Ensure you have your contractId query parameter.

  2. Build a new IdpDirectory object.

  3. POST the object to /crux/v1/mgmt-pop/idpdirectory{?contractId}.

  4. The operation responds with a IdpDirectory object.

Get an IDP directory

Gets the specified IDP directory.

GET /crux/v1/mgmt-pop/idpdirectory/{idpdirectory_id}{?contractId}

Sample: /crux/v1/mgmt-pop/idpdirectory/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
idpdirectory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each IDP directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: IdpDirectory

Download schema: idpdirectory.json

Response body:

{
    "mfa": "off",
    "ou_filter": null,
    "user_display_name": "displayName",
    "user_search_filter": "(&(objectClass=user)(objectClass=person))",
    "group_object_classes": [
        "group",
        "groupOfNames"
    ],
    "group_name": "cn",
    "password_change_allow": false,
    "agents": [],
    "group_search_filter": "(objectClass=group)",
    "group_base_dn": null,
    "directory_status": 3,
    "port": 636,
    "group_token": "primaryGroupToken",
    "ou_attr": null,
    "sync_interval": 21600,
    "user_count": 11,
    "service": 6,
    "resource_uri": {
        "href": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
        "users": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg/users/",
        "groups": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg/groups/"
    },
    "signed_request": false,
    "sync_state": 1,
    "root_dn": null,
    "auth_response_encrypt": false,
    "company_id": null,
    "logout_url": null,
    "user_memberof": "memberOf",
    "nameidformat": null,
    "uuid_url": "U59wJq3dQNuanDH8VMc1Gg",
    "api_key": null,
    "user_fname": "givenName",
    "conf_state": 1,
    "metadata": null,
    "auth_request_signed": false,
    "admin_user": null,
    "user_samaccountname": "sAMAccountName",
    "description": null,
    "password_policy_default": "",
    "group_members": "member",
    "user_upn": "userPrincipalName",
    "dialin_sni": null,
    "ssl": true,
    "group_count": 11,
    "global_catalog": false,
    "password_expire_warn_threshold": 0,
    "kerb_realms": [],
    "ou_object_classes": [
        "organizationalUnit"
    ],
    "user_memberuid": "memberUid",
    "user_lname": "sn",
    "chase_referral": false,
    "schema_attributes": "{}",
    "password_complexity_message": null,
    "password_change_threshold": 0,
    "resource": "directories",
    "name": "Cloud Directory",
    "user_phone_num": "telephoneNumber",
    "user_base_dn": null,
    "created_at": "2017-01-04T14:58:29.884927",
    "server_cert_validate": true,
    "modified_at": "2018-05-18T04:37:13.487706",
    "host": null,
    "attribute_map": {
        "user.phoneNumber": "cloud.phone_number",
        "user.countryCode": "cloud.country_code",
        "user.email": "cloud.email",
        "user.lastName": "cloud.last_name",
        "user.firstName": "cloud.first_name",
        "user.netbios": "cloud.netbios",
        "user.persistentId": "cloud.uuid",
        "user.samAccountName": "cloud.samaccountname",
        "user.userPrincipleName": "cloud.user_principle_name"
    },
    "last_sync": "2017-01-04T14:58:29.885037",
    "user_object_classes": [
        "person",
        "organizationalPerson",
        "user",
        "inetOrgPerson"
    ],
    "cname": null,
    "status": 1,
    "domains": [],
    "user_principal": "sAMAccountName",
    "password_filter": {},
    "directory_type": 1,
    "user_email": "mail",
    "password_reset_allow": false
}

  1. Run the List IDP directories operation and store the relevant id.

  2. Make a GET request to /crux/v1/mgmt-pop/idpdirectory/{id}.

  3. The operation responds with a IdpDirectory object.

Modify an IDP directory

Updates an existing IDP directory.

PUT /crux/v1/mgmt-pop/idpdirectory/{idpdirectory_id}{?contractId}

Sample: /crux/v1/mgmt-pop/idpdirectory/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Content-Type: application/json

Object type: IdpDirectory

Download schema: idpdirectory.json

Request body:

{
    "mfa": "off",
    "ou_filter": null,
    "user_display_name": "displayName",
    "user_search_filter": "(&(objectClass=inetOrgPerson)(objectClass=posixAccount))",
    "group_object_classes": [
        "group",
        "groupOfNames",
        "posixGroup"
    ],
    "group_name": "cn",
    "password_change_allow": false,
    "agents": [],
    "group_search_filter": "(|(objectClass=posixGroup)(objectClass=groupOfNames))",
    "group_base_dn": "ldapdomain",
    "directory_status": 3,
    "port": 636,
    "group_token": "gidNumber",
    "ou_attr": null,
    "sync_interval": 21600,
    "user_count": 0,
    "service": 2,
    "signed_request": false,
    "sync_state": 1,
    "root_dn": "ldapdomain",
    "auth_response_encrypt": false,
    "company_id": null,
    "logout_url": null,
    "user_memberof": "gidNumber",
    "nameidformat": null,
    "api_key": null,
    "user_fname": "givenName",
    "conf_state": 1,
    "metadata": null,
    "auth_request_signed": false,
    "admin_user": "admmin",
    "user_samaccountname": "uid",
    "description": null,
    "password_policy_default": "",
    "group_members": "member",
    "user_upn": "userPrincipalName",
    "dialin_sni": "dir-jex2kaugr-gimcthdupzza.login.dialin.stage.akamai-access.com",
    "ssl": true,
    "group_count": 0,
    "global_catalog": false,
    "password_expire_warn_threshold": 0,
    "kerb_realms": [],
    "ou_object_classes": [
        "organizationalUnit"
    ],
    "user_memberuid": "memberUid",
    "user_lname": "sn",
    "chase_referral": false,
    "schema_attributes": "{}",
    "password_complexity_message": "",
    "password_change_threshold": 0,
    "resource": "directories",
    "name": "idpDirectory#1",
    "user_phone_num": "telephoneNumber",
    "user_base_dn": "ldapdomain",
    "created_at": "2019-07-23T05:55:18.577022",
    "server_cert_validate": true,
    "host": "ldap.company.com",
    "attribute_map": {
        "user.phoneNumber": "telephoneNumber",
        "user.countryCode": "countryCode",
        "user.firstName": "givenName",
        "user.email": "mail",
        "user.lastName": "sn",
        "user.groups": "member",
        "user.netbios": "",
        "user.persistentId": "entryUUID",
        "user.samAccountName": "uid",
        "user.userPrincipleName": "userPrincipalName"
    },
    "last_sync": "2019-07-23T05:55:18.577146",
    "user_object_classes": [
        "person",
        "organizationalPerson",
        "user",
        "inetOrgPerson"
    ],
    "cname": "dir-jex2kaugr-gimcthdupzza.login.stage.akamai-access.com",
    "status": 1,
    "domains": [
        {
            "name": ""
        }
    ],
    "user_principal": "uid",
    "password_filter": {},
    "directory_type": 2,
    "user_email": "mail",
    "password_reset_allow": false,
    "admin_pwd": "3244234323"
}
Parameter Type Sample Description
URL path parameters
idpdirectory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each IDP directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: IdpDirectory

Download schema: idpdirectory.json

Response body:

{
    "admin_pwd": "3244234323",
    "admin_user": "admmin",
    "agents": [],
    "api_key": null,
    "attribute_map": {
        "user.countryCode": "countryCode",
        "user.email": "mail",
        "user.firstName": "givenName",
        "user.groups": "member",
        "user.lastName": "sn",
        "user.netbios": "",
        "user.persistentId": "entryUUID",
        "user.phoneNumber": "telephoneNumber",
        "user.samAccountName": "uid",
        "user.userPrincipleName": "userPrincipalName"
    },
    "auth_request_signed": false,
    "auth_response_encrypt": false,
    "chase_referral": false,
    "cname": "dir-jex2kaugr-gimcthdupzza.login.stage.akamai-access.com",
    "company_id": null,
    "conf_state": 1,
    "created_at": "2019-07-23T05:55:18.577022",
    "description": null,
    "dialin_sni": "dir-jex2kaugr-gimcthdupzza.login.dialin.stage.akamai-access.com",
    "directory_status": 3,
    "directory_type": 2,
    "domains": [],
    "global_catalog": false,
    "group_base_dn": "ldapdomain",
    "group_count": 0,
    "group_members": "member",
    "group_name": "cn",
    "group_object_classes": [
        "group",
        "groupOfNames",
        "posixGroup"
    ],
    "group_search_filter": "(|(objectClass=posixGroup)(objectClass=groupOfNames))",
    "group_token": "gidNumber",
    "host": "ldap.company.com",
    "kerb_realms": [],
    "last_sync": "2019-07-23T05:55:18.577146",
    "logout_url": "",
    "metadata": null,
    "mfa": "off",
    "modified_at": "2019-07-23T06:02:33.582676",
    "name": "idpDirectory#1",
    "nameidformat": null,
    "ou_attr": null,
    "ou_filter": null,
    "ou_object_classes": [
        "organizationalUnit"
    ],
    "password_change_allow": false,
    "password_change_threshold": 0,
    "password_complexity_message": "",
    "password_expire_warn_threshold": 0,
    "password_filter": {},
    "password_policy_default": "",
    "password_reset_allow": false,
    "port": 636,
    "resource": "directories",
    "resource_uri": {
        "groups": "/api/v1/directories/JEX2kaugR-GImctHdUpZzA/groups/",
        "href": "/api/v1/directories/JEX2kaugR-GImctHdUpZzA",
        "users": "/api/v1/directories/JEX2kaugR-GImctHdUpZzA/users/"
    },
    "root_dn": "ldapdomain",
    "schema_attributes": "{}",
    "server_cert_validate": true,
    "service": 2,
    "signed_request": false,
    "ssl": true,
    "status": 1,
    "sync_interval": 21600,
    "sync_state": 1,
    "user_base_dn": "ldapdomain",
    "user_count": 0,
    "user_display_name": "displayName",
    "user_email": "mail",
    "user_fname": "givenName",
    "user_lname": "sn",
    "user_memberof": "gidNumber",
    "user_memberuid": "memberUid",
    "user_object_classes": [
        "person",
        "organizationalPerson",
        "user",
        "inetOrgPerson"
    ],
    "user_phone_num": "telephoneNumber",
    "user_principal": "uid",
    "user_samaccountname": "uid",
    "user_search_filter": "(&(objectClass=inetOrgPerson)(objectClass=posixAccount))",
    "user_upn": "userPrincipalName",
    "uuid_url": "JEX2kaugR-GImctHdUpZzA"
}

  1. Run the List IDP directories operation and store the relevant id.

  2. Run the Get an IDP directory operation and store the response object.

  3. Modify the IdpDirectory object.

  4. PUT the object to /crux/v1/mgmt-pop/idpdirectory/{id}.

  5. The operation responds with a IdpDirectory object.

Delete an IDP directory

Deletes an existing IDP directory.

DELETE /crux/v1/mgmt-pop/idpdirectory/{idpdirectory_id}{?contractId}

Sample: /crux/v1/mgmt-pop/idpdirectory/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
idpdirectory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each IDP directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Run the List IDP directories operation and store the relevant id.

  2. Make a DELETE request to /crux/v1/mgmt-pop/idpdirectory/{id}.

Block a user

Blocks a user from accessing an application.

POST /crux/v1/mgmt-pop/idpblockuser/idp/{idp_id}/block{?contractId}

Sample: /crux/v1/mgmt-pop/idpblockuser/idp/Aqd-pa0eREipOappCFWt0g/block?contractId=F-EMGSGV

Content-Type: application/json

Object type: IdpBlockUser

Download schema: idpblockuser.json

Request body:

{
    "user_list": [
        {
            "user_id": "UcxX2qmATBeyADMt2oRxNw",
            "directory_id": "U59wJq3dQNuanDH8VMc1Gg"
        }
    ]
}
Parameter Type Sample Description
URL path parameters
idp_id String Aqd-pa0eREipOappCFWt0g A unique identifier for the IDP.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: IdpBlockUser

Download schema: idpblockuser.json

Response body:

{
    "failed_details": [],
    "success": 1,
    "failed": 0,
    "total": 1
}

  1. Run the List IDPs operation and store the relevant idp_id.

  2. Ensure you have your contractId query parameter.

  3. Build a new IdpBlockUser object.

  4. POST the object to /crux/v1/mgmt-pop/idpblockuser/idp/{idp_id}/block{?contractId}.

  5. The operation responds with an object containing the success and failure totals.

Unblock a user

Unblocks a user from accessing an application.

POST /crux/v1/mgmt-pop/idpblockuser/idp/{idp_id}/unblock{?contractId}

Sample: /crux/v1/mgmt-pop/idpblockuser/idp/Aqd-pa0eREipOappCFWt0g/unblock?contractId=F-EMGSGV

Content-Type: application/json

Object type: IdpBlockUser

Download schema: idpblockuser.json

Request body:

{
    "user_list": [
        {
            "user_id": "UcxX2qmATBeyADMt2oRxNw",
            "directory_id": "U59wJq3dQNuanDH8VMc1Gg"
        }
    ]
}
Parameter Type Sample Description
URL path parameters
idp_id String Aqd-pa0eREipOappCFWt0g A unique identifier for the IDP.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: IdpBlockUser

Download schema: idpblockuser.json

Response body:

{
    "failed_details": [],
    "success": 1,
    "failed": 0,
    "total": 1
}

  1. Run the List IDPs operation and store the relevant idp_id.

  2. Ensure you have your contractId query parameter.

  3. Build a new IdpBlockUser object.

  4. POST the object to /crux/v1/mgmt-pop/idpblockuser/idp/{idp_id}/unblock{?contractId}.

  5. The operation responds with an object containing the success and failure totals.

Get admin events reports

Returns a set of admin events reports with optional custom filters.

GET /crux/v1/mgmt-pop/api/v1/adminevents-reports/ops/reports{?contractId,sts,ets,event_type,res_type}

Sample: /crux/v1/mgmt-pop/api/v1/adminevents-reports/ops/reports?contractId=F-EMGSGV&sts=1563129000000&ets=1563355505606&event_type=login&res_type=user

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
ets String 1563355505606 End epoch timestamp of the report duration.
event_type Enumeration login Name of the event type, either login, config, or system.
res_type Enumeration user Name of the resource type, either user, application, or group.
sts Integer 1563129000000 Start epoch timestamp of the report duration.

Status 200 application/json

Response body:

[
    {
        "0": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1608214229086
        },
        "1": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1608195749063
        },
        "2": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1608192618254
        },
        "3": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1608182790422
        },
        "4": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1608181757056
        },
        "5": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1608098653099
        },
        "6": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1608092605635
        },
        "7": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1608035054699
        },
        "8": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1608028345871
        },
        "9": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1608019454975
        },
        "10": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1608004808832
        },
        "11": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1607918059702
        },
        "12": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1607671237477
        },
        "13": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1607576420203
        },
        "14": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1607573341324
        },
        "15": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1607517930313
        },
        "16": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1607427276904
        },
        "17": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1607419553378
        },
        "18": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606978068677
        },
        "19": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606978021799
        },
        "20": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606973368315
        },
        "21": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606968281479
        },
        "22": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "logout",
            "ts": 1606968272247
        },
        "23": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606968268669
        },
        "24": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606968261734
        },
        "25": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606910122687
        },
        "26": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606823877647
        },
        "27": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606714458185
        },
        "28": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606713477219
        },
        "29": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "changepasswd",
            "ts": 1606707715310
        },
        "30": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606707696606
        },
        "31": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "changepasswd",
            "ts": 1606707672537
        },
        "32": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606707606377
        },
        "33": {
            "uid": "user7@example.com",
            "tnid": "xzai569",
            "res_id": "wsJ7xkh2QGOoIHF8q7wfMg",
            "res_ty": "users",
            "event_ty": "login",
            "res_name": "user7@example.com",
            "event": "login",
            "ts": 1606705348966
        },
        "count": 34
    }
]

  1. Ensure you have your contractId query parameter.

  2. Set sts to the starting epoch timestamp of the report duration.

  3. Set ets to the ending epoch timestamp of the report duration.

  4. Set event_type to login, config, or system.

  5. Set res_type to either user, application, or group.

  6. Make a GET request to /crux/v1/mgmt-pop/api/v1/adminevents-reports/ops/reports{?contractId,sts,ets,event_type,res_type}.

  7. The operation responds with an object containing the admin events reports.

List certificates

Returns a list of all certificates.

GET /crux/v1/mgmt-pop/certificates{?contractId,offset,limit}

Sample: /crux/v1/mgmt-pop/certificates?contractId=F-EMGSGV&offset=10&limit=30

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Download schema: cert_get_list.json

Response body:

{
    "meta": {
        "previous": null,
        "total_count": 5,
        "offset": 0,
        "limit": 1000,
        "next": null
    },
    "objects": [
        {
            "status": 1,
            "resource": "certificates",
            "cn": "akamai.com",
            "days_left": 364,
            "resource_uri": {
                "href": "/api/v1/certificates/Jq2wsVfuRLadm4yMrOT58A"
            },
            "issuer": "C=IN/ST=KA/L=BLR/O=AKA/OU=ENT/CN=akamai.com/emailAddress=email@address.com",
            "apps": [],
            "created_at": "2019-07-10T11:54:14.418364",
            "cert_type": 1,
            "subject": "C=IN/ST=KA/L=BLR/O=AKA/OU=ENT/CN=akamai.com/emailAddress=email@address.com",
            "name": "bala7@bwrapp.com",
            "idps": [],
            "issued_at": "2019-07-10T11:51:35",
            "cert": "-----BEGIN CERTIFICATE-----\nMIIFyTCCA7GgAwIBAgIJAO3MKqYydvdmMA0GCSqGSIb3DQEBBQUAMHsxCzAJBgNV\nBAYTAklOMQswCQYDVQQIDAJLQTEMMAoGA1UEBwwDQkxSMQwwCgYDVQQKDANBS0Ex\nDDAKBgNVBAsMA0VOVDETMBEGA1UEAwwKYWthbWFpLmNvbTEgMB4GCSqGSIb3DQEJ\nARYRZW1haWxAYWRkcmVzcy5jb20wHhcNMTkwNzEwMTE1MTM1WhcNMjAwNzA5MTE1\nMTM1WjB7MQswCQYDVQQGEwJJTjELMAkGA1UECAwCS0ExDDAKBgNVBAcMA0JMUjEM\nMAoGA1UECgwDQUtBMQwwCgYDVQQLDANFTlQxEzARBgNVBAMMCmFrYW1haS5jb20x\nIDAeBgkqhkiG9w0BCQEWEWVtYWlsQGFkZHJlc3MuY29tMIICIjANBgkqhkiG9w0B\nAQEFAAOCAg8AMIICCgKCAgEAtpxoGy2xBwNWWHhbMwnl4nRP0fefS02h1nAeq9fH\noAeCFhQv2fb7MubWXartEEBemgpR10HZDS9AbiJfVY+7bvmXRmUE2UP7uTySf7V8\nXoZ/vqSwuIQ6K5jcQ1VCzGeisytjAkMfFn2DBujvuEPLeUXet7ZBf/lg9S2VXffP\nXpJ+mflWXUDU72bfXpf1of0gCsb84EYg2SN7GnpOhM8RNULRQ2pwAcnLKHuHDiuJ\n3EtzpbuN+w1rqHBhPWMQY4K1FfHBA8qj8pRSOexzMMJdTYNQ1B1ymrM3zmrNxyjB\nmPFRhGvxPRaUNYiFQIkWI8SZIT3nIWajSDQXkd8N3YtF1Hmctz39/LZ9EM+dHGhH\nuhVHfCLF46604KE3erl/oklORXfC9EPvb7EkUoZeCGDTBY3uHvQ4YupxYX7VGVNL\ndKkGLhkRq10gU7W/DV7CO3bd6gx+2uxHUODCpwxgbnhLE73gxAj6gmv0WVWUfvtF\nWsvdgkop2ssFOT8CcCq5+L7MNkOue0mPJJlsHw2lo4GWnzmPzQs41L1ztlh1cCqF\nCcQHEJ0cemepUZoWKmjjY/o2VQHzQJb438YzmtJYGrVsOjYF42wtpJBVVZ2y9Pd8\ncHuHPG5qo9PXFoZBpNFFQHRkE2J//upQj1K+xwvR3sWHQ0h6AfmYltT7wc8L6+f7\nxg0CAwEAAaNQME4wHQYDVR0OBBYEFG5TRVwz+LthO9Zi8X/m7Jh+grSWMB8GA1Ud\nIwQYMBaAFG5TRVwz+LthO9Zi8X/m7Jh+grSWMAwGA1UdEwQFMAMBAf8wDQYJKoZI\nhvcNAQEFBQADggIBAHMtbdX9BRtxbh6xWW0cHZgW29gr7CtFRtkZZuzA2McwZNT2\np3iqOh3NbmB03xKe0CKuLS0iESOdxFYSKWH6kKkYlGeA6h+PgqergVV4jlQivtha\nOXSsz0TTdRg69mJECHCHB6HqnT78fOka8Dy+UC/JWGjtNMhxtbVe56n1wdvPNK51\nS/ZbsS/JjUfySfwJY1lIiadjM0XeYpHSTVTJtvVVDbk3pdcVkYqTnXnNiWmIKofP\nuwzly5HCX7mcg5OMKG94sBhgHXs2TAcsFsb3a7yPUMDjpTQEcVF85sk27/BuDHyM\n1l/+0VHkyB4ZXUNelz841oV0vJ6m7gMmM6xEXaD3ECHm5cCFmAgzdHtMNy9W7SBl\ni5/mPpuPLUxxym300xQcDfdqg02nfZ1A2JS/sGlmJRiOXAM4Cu/ryChpQ7hPKnr9\nVmGv2pigaWmjdRGjYTneSvuDY3sAiphpxm4qMnzQUpIji3qVxGnTnnU/IuuZa5l6\nZXi/REwyzPOSlpIGW3XFYDs19xfsCcTBBNtWy/WDXj0IGLs4Yt/BocjkFz0hvLdq\nYil94rX1JzpujmIzG6SqdbKrRuvPMu6Ow5YJN9DTlgrjBP8urqO2T92FYx8vMPg2\n5vN+VTePR8sQE3iapCp/N3C/eiVqmah4KZLHE+zv5R8ErBpKE8o4MaKvpYZl\n-----END CERTIFICATE-----",
            "modified_at": "2019-07-10T11:54:14.418380",
            "uuid_url": "Jq2wsVfuRLadm4yMrOT58A",
            "app_count": 0,
            "expired_at": "2020-07-09T11:51:35",
            "description": null
        },
        {
            "status": 1,
            "resource": "certificates",
            "cn": "tunnel-master.login.stage.akamai-access.com",
            "days_left": 8655,
            "resource_uri": {
                "href": "/api/v1/certificates/X9CnR98mTDCSZxzqKYOkTQ"
            },
            "issuer": "CN=Soha/O=Soha Systems, Inc./L=Sunnyvale/ST=California/C=US",
            "apps": [],
            "created_at": "2018-03-21T12:07:56.946093",
            "cert_type": 5,
            "subject": "CN=tunnel-master.login.stage.akamai-access.com/O=Soha/L=Sunnyvale/ST=California/C=US",
            "name": "itQgMBYkSwyQxW15vKsIfA-idp-tunnel-master.login.stage.akamai-access.com",
            "idps": [],
            "issued_at": "2018-03-21T12:07:56",
            "cert": "-----BEGIN CERTIFICATE-----\nMIID3DCCAsSgAwIBAgIRAPQudyhSxUaprvB/Bd1whC4wDQYJKoZIhvcNAQELBQAw\nYjENMAsGA1UEAwwEU29oYTEbMBkGA1UECgwSU29oYSBTeXN0ZW1zLCBJbmMuMRIw\nEAYDVQQHDAlTdW5ueXZhbGUxEzARBgNVBAgMCkNhbGlmb3JuaWExCzAJBgNVBAYT\nAlVTMB4XDTE4MDMyMTEyMDc1NloXDTQzMDMyMjEyMDc1NlowezE0MDIGA1UEAxMr\ndHVubmVsLW1hc3Rlci5sb2dpbi5zdGFnZS5ha2FtYWktYWNjZXNzLmNvbTENMAsG\nA1UEChMEU29oYTESMBAGA1UEBxMJU3Vubnl2YWxlMRMwEQYDVQQIEwpDYWxpZm9y\nbmlhMQswCQYDVQQGEwJVUzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB\nAL72vN/2pHgdREyVwAptau96D6yIv08cgQOeq9dYPfWkjap1CTNAZVdPfrMj3XR7\nzdybASeJv+3n98NGCYoTjt8oHSag6IVdvcYHw54qz9LZanqsARgk/P+TimvF7xzU\nCUYeCHP1EhYBXAjhykpbm1hD1Tw2DbWQWYX5Mm0l697GE1mBaf51MKiF9c8DoOMk\nXA/FuxohGqG8B+Ik87p7M/faFQXhrNSGZIi1yZxLB4vWFsPs0XV/TWkxcvQAqcKn\njs/xVzIsYj2fg1QmWFphhjnpkqtfL/7Wu7Tm8QzB/GYXb2LPl6GQsC8lGcyLqj6A\nozoH0PvKn9dZ2IP9lQl+8EkCAwEAAaN0MHIwDAYDVR0TAQH/BAIwADALBgNVHQ8E\nBAMCB4AwNgYDVR0RBC8wLYIrdHVubmVsLW1hc3Rlci5sb2dpbi5zdGFnZS5ha2Ft\nYWktYWNjZXNzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwDQYJ\nKoZIhvcNAQELBQADggEBAIbTIulmjzyqtu/BUH0/pgHXHm8NrjNXqJjdmjA5vJLe\nROYVQ2j8A/1+p2pru+x8Mq+rY+Gt3tgtd8YM727AAAX+LQVeh/iQ9iz860A9u5Ac\nsK8qauprKwDHqDaMk7ZXtQJaQxQpLLteiG0yThU+tKfudz5O6vXmMVrqXlRamNPD\nG8qvBR2c3IAvY+40x9XCJICw87MNtyZUACBM1mxF1gdaYgztbL1JlbiqH0EbxFRC\nvLan2XdK5bYtStlRHR+YQrb5EugWeI65BFE3ueKKtdy8Irh345kcmJTdOBjVXPb1\nfLjUASg/Y1iVIVZic/hkJaiJwimFJrxI8W5M41JTF/A=\n-----END CERTIFICATE-----\n",
            "modified_at": "2018-03-21T12:07:56.946126",
            "uuid_url": "X9CnR98mTDCSZxzqKYOkTQ",
            "app_count": 0,
            "expired_at": "2043-03-22T12:07:56",
            "description": ""
        },
        {
            "status": 1,
            "resource": "certificates",
            "cn": "bala7-test-saml.login.stage.akamai-access.com",
            "days_left": 8676,
            "resource_uri": {
                "href": "/api/v1/certificates/vqShYlbpTzGSDyLOUNgR7A"
            },
            "issuer": "CN=Soha/O=Soha Systems, Inc./L=Sunnyvale/ST=California/C=US",
            "apps": [],
            "created_at": "2018-04-11T10:51:29.443157",
            "cert_type": 5,
            "subject": "CN=bala7-test-saml.login.stage.akamai-access.com/O=Soha/L=Sunnyvale/ST=California/C=US",
            "name": "itQgMBYkSwyQxW15vKsIfA-idp-bala7-test-saml.login.stage.akamai-access.com",
            "idps": [],
            "issued_at": "2018-04-11T10:51:29",
            "cert": "-----BEGIN CERTIFICATE-----\nMIID3zCCAsegAwIBAgIQPvzbKQeMS2e0YnKBJSsG4zANBgkqhkiG9w0BAQsFADBi\nMQ0wCwYDVQQDDARTb2hhMRswGQYDVQQKDBJTb2hhIFN5c3RlbXMsIEluYy4xEjAQ\nBgNVBAcMCVN1bm55dmFsZTETMBEGA1UECAwKQ2FsaWZvcm5pYTELMAkGA1UEBhMC\nVVMwHhcNMTgwNDExMTA1MTI5WhcNNDMwNDEyMTA1MTI5WjB9MTYwNAYDVQQDEy1i\nYWxhNy10ZXN0LXNhbWwubG9naW4uc3RhZ2UuYWthbWFpLWFjY2Vzcy5jb20xDTAL\nBgNVBAoTBFNvaGExEjAQBgNVBAcTCVN1bm55dmFsZTETMBEGA1UECBMKQ2FsaWZv\ncm5pYTELMAkGA1UEBhMCVVMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB\nAQDxDP6/QJmEuQHL5bqICurgSRXCva6GQ7BJGrfS5a34fA+ANO7XRkvOE0J6prpE\nVuidNCsj7/HBn62tvFeRk1UehUZ/LfNDWnTkTgkhCgPbOLog9+vJgKCw+k4fch9+\npGlkvZdar88hh/1EYyiezumKU/JwxAlS9bL6w2ZHD6eclsjbfifwPzfyx2Gysd9H\noHMUiRBVvzzdLpHH6Ihlf2TcFE0e7Dx0EZ8KdUqw5egOLq8MoLet3v5Zfsnfkbku\nHHhsYFy9i6R+1MhT8wgf9u0/g29VEOWuAhAAB5+IF2lrAeFVRkmHASXL/WQJaYUk\nKdigV2qGlcuKO84xKTVSIziFAgMBAAGjdjB0MAwGA1UdEwEB/wQCMAAwCwYDVR0P\nBAQDAgeAMDgGA1UdEQQxMC+CLWJhbGE3LXRlc3Qtc2FtbC5sb2dpbi5zdGFnZS5h\na2FtYWktYWNjZXNzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEw\nDQYJKoZIhvcNAQELBQADggEBAJiNW6ziRblT98o+2ytVOm8sSr29lcDqxTRohw1s\noI99r3/PlwVV17SiPRltp0mCY2oh9Irlonit+7waYrNE3UNJP+tLcZYqgcTojuJi\nmzGdRUWSnl5QsA0yjNR6QueqNCd0LZanE+S+4bObD0Ka8fDpqTwWYXZuZeXQlN5y\nZHzUXhfGsv9vOOHnYOr/Vz2rnKtAhibRa2MtXV2VYWF+eYUsqJvrUrXz74Pxk0EX\nsZCA0k8kGocxELHK872LkNSqmxnhPYU71C8f0O1jWls6plYQcoXUnuAZrqB9HuJG\n+Qkrg6FtJ3Fm/BrXQ+sAif2fHtn/afi0Y+47mYfC9vsUAUs=\n-----END CERTIFICATE-----\n",
            "modified_at": "2018-04-11T10:51:29.443176",
            "uuid_url": "vqShYlbpTzGSDyLOUNgR7A",
            "app_count": 0,
            "expired_at": "2043-04-12T10:51:29",
            "description": ""
        },
        {
            "status": 1,
            "resource": "certificates",
            "cn": "cloud-idp-bala7",
            "days_left": 8564,
            "resource_uri": {
                "href": "/api/v1/certificates/xr2Fy6NIQjCyqDSZNB5DWg"
            },
            "issuer": "CN=Soha/O=Soha Systems, Inc./L=Sunnyvale/ST=California/C=US",
            "apps": [],
            "created_at": "2017-12-20T17:31:42.214839",
            "cert_type": 5,
            "subject": "CN=cloud-idp-bala7/O=Soha/L=Sunnyvale/ST=California/C=US",
            "name": "cloud-idp-bala7",
            "idps": [],
            "issued_at": "2017-12-20T17:31:42",
            "cert": "-----BEGIN CERTIFICATE-----\nMIIDpDCCAoygAwIBAgIRAJ8IbAOFBECdknvNiGUNyxUwDQYJKoZIhvcNAQELBQAw\nYjENMAsGA1UEAwwEU29oYTEbMBkGA1UECgwSU29oYSBTeXN0ZW1zLCBJbmMuMRIw\nEAYDVQQHDAlTdW5ueXZhbGUxEzARBgNVBAgMCkNhbGlmb3JuaWExCzAJBgNVBAYT\nAlVTMB4XDTE3MTIyMDE3MzE0MloXDTQyMTIyMTE3MzE0MlowXzEYMBYGA1UEAxMP\nY2xvdWQtaWRwLWJhbGE3MQ0wCwYDVQQKEwRTb2hhMRIwEAYDVQQHEwlTdW5ueXZh\nbGUxEzARBgNVBAgTCkNhbGlmb3JuaWExCzAJBgNVBAYTAlVTMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzdl0F/UAtKAZdsYFhWQWDDXWerGxlN5bL3jb\noJewTwC1MIkB7051piDtn2tKcyWqI+ZvSW4UqVbvdGqbW7v3CzCsQvzMx8YIdoKP\nRGEjWF2Oy7AuqRcaBo/vWWsfI47Cd26Nj4HWPwv5YUv2PuK94O7tc4uVTH6nWVNc\nJM0ayIcJg2Y+jsLRlo3UbTMNCmqH9/06J50YNjlEdlf5P5DV9gT0ZppI8mvmXOe4\nKaRjYKZIpJrVGT+OmexX+Brzbf89mjs0kcKXKJZP4XP8XQkjOr3WeQtFWCfWoaJW\nZq4qxvbw71GxLrICYJq5ApwvaGLk65ssKRY8MKXR9c+T/M9x4wIDAQABo1gwVjAM\nBgNVHRMBAf8EAjAAMAsGA1UdDwQEAwIHgDAaBgNVHREEEzARgg9jbG91ZC1pZHAt\nYmFsYTcwHQYDVR0lBBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMBMA0GCSqGSIb3DQEB\nCwUAA4IBAQClQP6FoOs73kPWciMUcLhlZAlyJeDhLGUtYIf4BdWRAQ1bgxNWlfkM\naMSetttXNUtDWY8kZ0VXrjDds734sup4hIGdysmAU0ebx2uPih6GG2W7R6HdvTbh\nHgh2V04i2SjUur3lN9gDqBof8XlCoUcVPW9kUm431DsI7t0HqIB10VCNWXaaIyY1\n0+6DeqGsGQD6WRf8tt9vYp+RKAsh8uTcP6J8HYnBW+R3/MYMD0v8MwsplMfJtp4k\np83LjC5IjF4okXsghBNVB8Q0oEsKlTyO2odvFqGolPPbxP0IeuSYlZMqWvSMZlr9\nP6EvlJU2bJl4+s0LG91xIELL+2ZG93hU\n-----END CERTIFICATE-----\n",
            "modified_at": "2017-12-20T17:31:42.214858",
            "uuid_url": "xr2Fy6NIQjCyqDSZNB5DWg",
            "app_count": 0,
            "expired_at": "2042-12-21T17:31:42",
            "description": ""
        },
        {
            "status": 1,
            "resource": "certificates",
            "cn": "cloud-idp-bala7.net",
            "days_left": 8564,
            "resource_uri": {
                "href": "/api/v1/certificates/RTa6VIxwSza2SluHO1oFaQ"
            },
            "issuer": "CN=Soha/O=Soha Systems, Inc./L=Sunnyvale/ST=California/C=US",
            "apps": [],
            "created_at": "2017-12-20T17:31:49.118779",
            "cert_type": 5,
            "subject": "CN=cloud-idp-bala7.net/O=Soha/L=Sunnyvale/ST=California/C=US",
            "name": "cloud-idp-bala7.net",
            "idps": [],
            "issued_at": "2017-12-20T17:31:49",
            "cert": "-----BEGIN CERTIFICATE-----\nMIIDrDCCApSgAwIBAgIRAIt0Hmesz0HZrwwu83jk5okwDQYJKoZIhvcNAQELBQAw\nYjENMAsGA1UEAwwEU29oYTEbMBkGA1UECgwSU29oYSBTeXN0ZW1zLCBJbmMuMRIw\nEAYDVQQHDAlTdW5ueXZhbGUxEzARBgNVBAgMCkNhbGlmb3JuaWExCzAJBgNVBAYT\nAlVTMB4XDTE3MTIyMDE3MzE0OVoXDTQyMTIyMTE3MzE0OVowYzEcMBoGA1UEAxMT\nY2xvdWQtaWRwLWJhbGE3Lm5ldDENMAsGA1UEChMEU29oYTESMBAGA1UEBxMJU3Vu\nbnl2YWxlMRMwEQYDVQQIEwpDYWxpZm9ybmlhMQswCQYDVQQGEwJVUzCCASIwDQYJ\nKoZIhvcNAQEBBQADggEPADCCAQoCggEBALyCBr7oOGMPU0qcXsmwEWWdvP/4W6Yh\nnakI1XN0qmi0rKKd38ZTpns6sEJ+F8ZdhKcCofsGjgjsB9ZuYKUVXxNceFAAEbK+\nBOJa9GN9TKFxQgRkyejrvxZ46GCbUR+UBsf9h67ZvqpGeMQxqyfEqHI1JaUlm2ZX\nyVsUW3Q8kbwuxdnSHQ8hEPTWWGP00bRch8Us+GRKBk1Na6MMI2txEBWsjz7fnunq\nI30G3CbjHA5LEuzHZNkEQASvjxTud5LY+zLm39coA5AwWV0ylm/Y7TF2tMEo2EuK\nUalTiJVhVzQfnxBPHXZbcXQQG5MLvjRBANoxNqmns6Nt1FA3de2zOPsCAwEAAaNc\nMFowDAYDVR0TAQH/BAIwADALBgNVHQ8EBAMCB4AwHgYDVR0RBBcwFYITY2xvdWQt\naWRwLWJhbGE3Lm5ldDAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwDQYJ\nKoZIhvcNAQELBQADggEBADbwJhw4UEwQTNmVVog5hBupKaKA6fXM22Hi9RcWQQ5q\n5SVQ1cPHYSXVO1+uCFm+b+POCE7MQx97Jp2FmoI5U8PR21FQZye60LQJ11X8yFwm\najR+bQ9wkLU1o1nSjOfgcim/Yla8Y/fBHEprFLkFxmBBYszDqcahooAF+gGDnOmP\n0FSzislvZfnegIDki+sPaMXiNGaatCpHQoSlE09GuON/UbVkamLn6afA8xpvm2LF\n4g2eUy+rzTGyiLEEj/Zwl5+ag1toFUMn/Pq2WckrqU50P5NFg69E7pPVP0UscDvs\nOtVo6DTkcMTgklV8Tb/Sl5Ra3RU+Nq1Byh4HGvrkOGg=\n-----END CERTIFICATE-----\n",
            "modified_at": "2017-12-20T17:31:49.118798",
            "uuid_url": "RTa6VIxwSza2SluHO1oFaQ",
            "app_count": 0,
            "expired_at": "2042-12-21T17:31:49",
            "description": ""
        },
        {
            "status": 1,
            "resource": "certificates",
            "cn": "cloud-idp-bala7.login.stage.akamai-access.com",
            "days_left": 8509,
            "resource_uri": {
                "href": "/api/v1/certificates/0RZOF4e5RX6NfYZnele14A"
            },
            "issuer": "CN=Soha/O=Soha Systems, Inc./L=Sunnyvale/ST=California/C=US",
            "apps": [],
            "created_at": "2017-10-26T21:36:37.188126",
            "cert_type": 5,
            "subject": "CN=cloud-idp-bala7.login.stage.akamai-access.com/O=Soha/L=Sunnyvale/ST=California/C=US",
            "name": "owwCheBMRf-GlYdR28Le1g-idp-cloud-idp-bala7.login.stage.akamai-access.com",
            "idps": [],
            "issued_at": "2017-10-26T21:36:37",
            "cert": "-----BEGIN CERTIFICATE-----\nMIID3zCCAsegAwIBAgIQYLUTG4p5SleKzSbtncFljTANBgkqhkiG9w0BAQsFADBi\nMQ0wCwYDVQQDDARTb2hhMRswGQYDVQQKDBJTb2hhIFN5c3RlbXMsIEluYy4xEjAQ\nBgNVBAcMCVN1bm55dmFsZTETMBEGA1UECAwKQ2FsaWZvcm5pYTELMAkGA1UEBhMC\nVVMwHhcNMTcxMDI2MjEzNjM3WhcNNDIxMDI3MjEzNjM3WjB9MTYwNAYDVQQDEy1j\nbG91ZC1pZHAtYmFsYTcubG9naW4uc3RhZ2UuYWthbWFpLWFjY2Vzcy5jb20xDTAL\nBgNVBAoTBFNvaGExEjAQBgNVBAcTCVN1bm55dmFsZTETMBEGA1UECBMKQ2FsaWZv\ncm5pYTELMAkGA1UEBhMCVVMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB\nAQC6XuQr7hpGUUPbwIqLIZB38KvYuXUaKhF38/fZL1GezSlZMxRe4aHpe5pUY8Mx\neOndGeZ7yWSM52yDONuu6J6UQKwNxLf++ZtSG8vsdVEoPSycQu+fFZ1M3y1mYaTU\nTeOV62zLliD0P8OSp7lK6WMMk/hlqfsCfOlUFKQyrEiFAosqw24fHeNZ18njSwxw\n4deZXzkS7qbCngTQvsyYBq1SDNPLFIPAR4sPd3uW0lCNXuBsxcfeNHmBAaTFEJ75\ncYkVxxfThZlQNbtYO3gq/TZ/aZ2IohIUYeiQSQH2jkFbpojEknq1qmFilHrZ3c47\nCRRgd29hj6v3BwxwuIK4Ju6JAgMBAAGjdjB0MAwGA1UdEwEB/wQCMAAwCwYDVR0P\nBAQDAgeAMDgGA1UdEQQxMC+CLWNsb3VkLWlkcC1iYWxhNy5sb2dpbi5zdGFnZS5h\na2FtYWktYWNjZXNzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEw\nDQYJKoZIhvcNAQELBQADggEBAHZY+p8zhft4AJFXmciZMcv0I01a5Qovp+Wm9Dnf\nFye8TtpM3y6BSRw+85MPjj6jNL9WliEnwi9EK76yOJRkYGcwPEiORC3fWgPJQjX5\nnt3162noU76w8RUv5qddqYgZS3vru121I50kPIw7D87ViFqyQVVKg12bnebk6dAp\new2XXaTMAOIAKEizhnSdaEu2HwjnYYuZhQUR42raN283v13MoQgbLJNGnPT7qUb0\nrFS65HFOh8o6cBkaP8GJBaWLpDHdcB53XzRG9u2BGMHFzDnikGInqqVRHYgSTXin\nyszMg5qEgi1loJH897d5ARIplNLaYEmlu0vsYT6EMnvhvKw=\n-----END CERTIFICATE-----\n",
            "modified_at": "2017-10-26T21:36:37.188144",
            "uuid_url": "0RZOF4e5RX6NfYZnele14A",
            "app_count": 0,
            "expired_at": "2042-10-27T21:36:37",
            "description": ""
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. For pagination, set offset the number of members to skip in the object list.

  3. For a pagination, set limit to specify the maximum number of members to return in the response.

  4. Make a GET request to /crux/v1/mgmt-pop/certificates{?contractId,offset,limit}.

  5. The operation responds with a list of certificates.

Create a certificate

Creates a new certificate.

POST /crux/v1/mgmt-pop/certificates{?contractId}

Sample: /crux/v1/mgmt-pop/certificates?contractId=F-EMGSGV

Content-Type: application/json

Download schema: cert_post_response.json

Request body:

{
    "cert": "-----BEGIN CERTIFICATE-----\nMIIFyTCCA7GgAwIBAgIJAO3MKqYydvdmMA0GCSqGSIb3DQEBBQUAMHsxCzAJBgNV\nBAYTAklOMQswCQYDVQQIDAJLQTEMMAoGA1UEBwwDQkxSMQwwCgYDVQQKDANBS0Ex\nDDAKBgNVBAsMA0VOVDETMBEGA1UEAwwKYWthbWFpLmNvbTEgMB4GCSqGSIb3DQEJ\nARYRZW1haWxAYWRkcmVzcy5jb20wHhcNMTkwNzEwMTE1MTM1WhcNMjAwNzA5MTE1\nMTM1WjB7MQswCQYDVQQGEwJJTjELMAkGA1UECAwCS0ExDDAKBgNVBAcMA0JMUjEM\nMAoGA1UECgwDQUtBMQwwCgYDVQQLDANFTlQxEzARBgNVBAMMCmFrYW1haS5jb20x\nIDAeBgkqhkiG9w0BCQEWEWVtYWlsQGFkZHJlc3MuY29tMIICIjANBgkqhkiG9w0B\nAQEFAAOCAg8AMIICCgKCAgEAtpxoGy2xBwNWWHhbMwnl4nRP0fefS02h1nAeq9fH\noAeCFhQv2fb7MubWXartEEBemgpR10HZDS9AbiJfVY+7bvmXRmUE2UP7uTySf7V8\nXoZ/vqSwuIQ6K5jcQ1VCzGeisytjAkMfFn2DBujvuEPLeUXet7ZBf/lg9S2VXffP\nXpJ+mflWXUDU72bfXpf1of0gCsb84EYg2SN7GnpOhM8RNULRQ2pwAcnLKHuHDiuJ\n3EtzpbuN+w1rqHBhPWMQY4K1FfHBA8qj8pRSOexzMMJdTYNQ1B1ymrM3zmrNxyjB\nmPFRhGvxPRaUNYiFQIkWI8SZIT3nIWajSDQXkd8N3YtF1Hmctz39/LZ9EM+dHGhH\nuhVHfCLF46604KE3erl/oklORXfC9EPvb7EkUoZeCGDTBY3uHvQ4YupxYX7VGVNL\ndKkGLhkRq10gU7W/DV7CO3bd6gx+2uxHUODCpwxgbnhLE73gxAj6gmv0WVWUfvtF\nWsvdgkop2ssFOT8CcCq5+L7MNkOue0mPJJlsHw2lo4GWnzmPzQs41L1ztlh1cCqF\nCcQHEJ0cemepUZoWKmjjY/o2VQHzQJb438YzmtJYGrVsOjYF42wtpJBVVZ2y9Pd8\ncHuHPG5qo9PXFoZBpNFFQHRkE2J//upQj1K+xwvR3sWHQ0h6AfmYltT7wc8L6+f7\nxg0CAwEAAaNQME4wHQYDVR0OBBYEFG5TRVwz+LthO9Zi8X/m7Jh+grSWMB8GA1Ud\nIwQYMBaAFG5TRVwz+LthO9Zi8X/m7Jh+grSWMAwGA1UdEwQFMAMBAf8wDQYJKoZI\nhvcNAQEFBQADggIBAHMtbdX9BRtxbh6xWW0cHZgW29gr7CtFRtkZZuzA2McwZNT2\np3iqOh3NbmB03xKe0CKuLS0iESOdxFYSKWH6kKkYlGeA6h+PgqergVV4jlQivtha\nOXSsz0TTdRg69mJECHCHB6HqnT78fOka8Dy+UC/JWGjtNMhxtbVe56n1wdvPNK51\nS/ZbsS/JjUfySfwJY1lIiadjM0XeYpHSTVTJtvVVDbk3pdcVkYqTnXnNiWmIKofP\nuwzly5HCX7mcg5OMKG94sBhgHXs2TAcsFsb3a7yPUMDjpTQEcVF85sk27/BuDHyM\n1l/+0VHkyB4ZXUNelz841oV0vJ6m7gMmM6xEXaD3ECHm5cCFmAgzdHtMNy9W7SBl\ni5/mPpuPLUxxym300xQcDfdqg02nfZ1A2JS/sGlmJRiOXAM4Cu/ryChpQ7hPKnr9\nVmGv2pigaWmjdRGjYTneSvuDY3sAiphpxm4qMnzQUpIji3qVxGnTnnU/IuuZa5l6\nZXi/REwyzPOSlpIGW3XFYDs19xfsCcTBBNtWy/WDXj0IGLs4Yt/BocjkFz0hvLdq\nYil94rX1JzpujmIzG6SqdbKrRuvPMu6Ow5YJN9DTlgrjBP8urqO2T92FYx8vMPg2\n5vN+VTePR8sQE3iapCp/N3C/eiVqmah4KZLHE+zv5R8ErBpKE8o4MaKvpYZl\n-----END CERTIFICATE-----",
    "name": "abc@def.com",
    "password": "verygoodpassswrd",
    "private_key": "-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIIJjjBABgkqhkiG9w0BBQ0wMzAbBgkqhkiG9w0BBQwwDgQI6l2vpR+MedQCAggA\nMBQGCCqGSIb3DQMHBAg4i0t2gKwtoASCCUjQHSXC8u5nloIOZF7RAq+2quxwypAm\nZj/SzFYl6GAKFEnQQRVyTWIup4fb0EaQsKd75lgAMMvOJ0OMc6VIKUaEIWNZitN4\nuLw2LBVy4FTPys6nKSTAwmcvHW60LMzmN0IFb8g7OuTwz68jFuog1jWUY9O1Bwcd\nWJzgQ0sP/pXKxjqXkGoewGq7AZFh1wV3rQvHUN1i0jQs8x9rzA6etU5+CxPEHVMR\ni098HsNu1Du59bZLfDKwAsARMfFm5OyVpNcqLcnIXAtoKCKJg1jxl8yzZ0iZ4jOn\nNPdZA9nweuqzzrskZvSEh4epAc/Xg9ECt2CNKSA7+NgLBE3X8ZP8j684Wf+TqVGO\ne4sPiA1ZBg+pGdS7bSgITeRgXtWa30br8rq2wJ0FpGLzd6oGJeRl3HYDfMFo6qvU\nEYJa6s1sPsfuFsuwk/fmAv4NGVaqUyxQ/w2N7tCFakX8r+zAYa+Yk9C6mMdKbT+Z\n3EnLkybZnJGPok5elomMl+VIlGJOWHpZAq7d7UAkeGCZHv9KvX2Tv/8oqu6xnVfD\nMkqSafNXpbVpz+qUTFQIaTRR6OjmbcOicA+J4jUCiaOmu+nUCZ8yikh3ZlThcEuO\nzMjjN3cHZnbtZQbH32bfWAwS2YXWmbS7xEoD5QEc7OEewMOqnJmTyxS4NQs1xGcI\nnvaLqVE8u3Xm65/9JKyBOXzvrn55a9ZCA/feNSksUUbqmEPds3F+GhTX3w4QARWt\n3YJTceDxR7TvMtyO5JKj38Tuu4rxLdDCxfCrL0mGSvL7A7nHd9I9lxPr1iM1AxIM\nLGp3cmsqd4+ZY9cOyBsypffmdnT53mrSA1JjLOIwlQX7oV0fDaTIJ+WPycglMChT\nGBc1boHvPejArl0fnw9mNkcT+TGjBupJfZFvOnpF8oYeVUlBWWT2QfcrRiy/qXii\nUkJPrOoJ00sE6gpt8o4zPO87TezS1ngo7lvBYoTIvkS4bhr7tDBuc0kHCCMgIMul\n3qBKIDmKf6ffK4p2geJMVfQlxHOyz0BmWXF3R7abfPBSzisPTmecEbN6tNEpJM+6\n7yBo/scCiESYRfWCHjdYQ5SPMBp6NBbmmIrhV09rzX4BzDCsnAIsLacI73ErdTna\n2I1AEVG9ZVHymrbDZKWIVOMhUOqTI4KfQjWw2wwf1LM6wxBIk0v2hsCNUyr15mHk\n/8hJWn7DYg13H13d+Ej0S+wD2FqcYAMqh08lx5jCeYFsCz4u4dRlHnIENDaH2v7D\n/8X44XOcIs0AL68MYPQr/0W2uOWZ+cakrCySntkBmT8UpVbb2odEGnwMZLYg8uGH\ndjc1hfvYLyxNx5E88AFn9evFE9ZrEWCGQhyab75yrZYNbcX0xDJY/SVWwe4Urjo5\nalgibGxYNFyagvlPVmUqKH4RJBeb8SG6c6X/FpphOwH01EksYi9nI1+ax+ideqiQ\nKKzoHQ/lQoCQsUa/uzY/SRLP0oON6wE56jfycIvqs8oqP4o5kkBohWjeWNcG5szw\nfTrKnRgVymBnFufVxrWOsnTOy9Eywo5693tZ19XmW0qJpg6GT3nBUoTLEkRhTkTg\n8vo8ZUMI6BfezdH+esJVGnlt/uzbZ6sssOUM+74GDVWuqIZe59n9Qj69iGxESujA\nsajwtR6TC8i93tqTiPZoKuVTm8P+rJWZhaEhf+OJyK4nh++fVscEB0M2/pxh9mIt\n8zuxz89xeK3mir879dS600eEbEkNASyAhWVDK1pqZa7TuJhooub1Zg6lPm/16HA2\nYKDu07LtawyCjOj96Fq1Rw3XtygEjvM3XdKADSPyniZrAuR4LZlmhjhnd9I4m/Xu\nBsLCszDBBOOFGJOuWQf10pt0WjglwhahuLD14v9HXdtYa1b/8cYpDBhxVndcIEaW\nGfwvYpTlxKahl8ynrtw5miShaJESIAgpjpxy7qER6WRs2jTfCHWH/9GklI7Xau4f\n2ftQNxXewi61WQPkR+I7k8EZxza36/b+vfEoVgpdTYq1B3qdBiOEI99xoAmmfawu\nPp2orzmtELVxPBXizpE/HdXMsty7zII3yy+alJrHdfnMKwh+yd3Jj3YmGcNd0ISF\nUqFbWlnzZI+iyCSDW4LZ4kV43q9DbGMljipQAWjZJFjsL9BwIBFQMqYW8PzwqY7j\nZJjN4/esrHuRz26lHPNwccoemOyKrcR+sCwz0PR1Afey9Lmf0rCDWshjzhRp8VS1\n9qBOKOiAGyU9C/Ykj8W8B9G0mHa+uSnJ6gDqMa3x605QT43z9kZyf5kpu0VZYE3D\ngsWc2DAin5bhQQvv5pNPpvLnAFWaHtZ1i4K+BHXw/q64geTKIZXPBA+/HZ7OKyPw\nrTwFmZCgyUxNOekaR150ROXvK+2QT3nsfAsAfBSE9//vVSBsJWCvXUJs8dBk0oJh\n4+ZtIpV2cP4VfA2MIfz4FMdjOdbr+WmdhhqK55jqpMKNWS0tbpHjwda0nzigTTQ+\nNpJYtOMSkk3uE7aOKNkKHk6/4LTusfXt9wjcgngeO87QCotc3cTqTGhYUvXlXJlI\nynzr+bhoRR/jiiA1oig3oPm78Q+Row4KnXGHKz9ofPv5TTLkqMrxBUvxNln85AiC\niVJTPXvWJ8/3mQiMGRJh7+719DwmAZ6/f9Z5dL+l9kiQzrdOnG+xNCtFesRBhEoq\nGlP/+W/ewieU0WMDat+QKcHbpIU+HolnJDTXDuDubDaYZszfh1kxm8D8YEb3FcyP\nUrR9eIEsIId3eXGoXAVJ5mrw21VtptHy3bT+Hxbx2E9qTyaLzvKuulKbbXusZ/LI\nJiIv8pjtabQuCfK0BSdTKbPpZx6VnwxZ55SVaK4AoI6+ATx7/vphhDUS0tMDYNmH\nZA1xlciC3k0cxQaqj1UiuqV5p3S41Jd61ROyDR3/+UBmmZc0KtUu2E+Gqa3Nsiom\nDMbdFEk5qa1ar2M55+6Iw4lFcN9qiy3iXsi2BHqr+f7JZMybvgIqPecPtV+tRWPZ\n9LX3z21T2oC6jeFNJAUtBzlBftYDDyzj9ZCF5Hols5EBNcKo55cFBIH1Iy7C4/BD\nDmOUw+Tat+unSDCIXNzd9JwoLHK6WVqFy1A5WL/ZxfCdPt5FGYLTvc6MiZvOvs46\nFf8X6Rg2AcYDMayQFXYqTulFhyVVz829dJ8aZzm3o4/j6z3KWcgeEppBHqVeFAoK\n/Fk=\n-----END ENCRYPTED PRIVATE KEY-----"
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: certificates.json

Response body:

{
    "name": "abc@def.com",
    "description": null,
    "app_count": 0,
    "cert": "-----BEGIN CERTIFICATE-----\nMIIFyTCCA7GgAwIBAgIJAO3MKqYydvdmMA0GCSqGSIb3DQEBBQUAMHsxCzAJBgNV\nBAYTAklOMQswCQYDVQQIDAJLQTEMMAoGA1UEBwwDQkxSMQwwCgYDVQQKDANBS0Ex\nDDAKBgNVBAsMA0VOVDETMBEGA1UEAwwKYWthbWFpLmNvbTEgMB4GCSqGSIb3DQEJ\nARYRZW1haWxAYWRkcmVzcy5jb20wHhcNMTkwNzEwMTE1MTM1WhcNMjAwNzA5MTE1\nMTM1WjB7MQswCQYDVQQGEwJJTjELMAkGA1UECAwCS0ExDDAKBgNVBAcMA0JMUjEM\nMAoGA1UECgwDQUtBMQwwCgYDVQQLDANFTlQxEzARBgNVBAMMCmFrYW1haS5jb20x\nIDAeBgkqhkiG9w0BCQEWEWVtYWlsQGFkZHJlc3MuY29tMIICIjANBgkqhkiG9w0B\nAQEFAAOCAg8AMIICCgKCAgEAtpxoGy2xBwNWWHhbMwnl4nRP0fefS02h1nAeq9fH\noAeCFhQv2fb7MubWXartEEBemgpR10HZDS9AbiJfVY+7bvmXRmUE2UP7uTySf7V8\nXoZ/vqSwuIQ6K5jcQ1VCzGeisytjAkMfFn2DBujvuEPLeUXet7ZBf/lg9S2VXffP\nXpJ+mflWXUDU72bfXpf1of0gCsb84EYg2SN7GnpOhM8RNULRQ2pwAcnLKHuHDiuJ\n3EtzpbuN+w1rqHBhPWMQY4K1FfHBA8qj8pRSOexzMMJdTYNQ1B1ymrM3zmrNxyjB\nmPFRhGvxPRaUNYiFQIkWI8SZIT3nIWajSDQXkd8N3YtF1Hmctz39/LZ9EM+dHGhH\nuhVHfCLF46604KE3erl/oklORXfC9EPvb7EkUoZeCGDTBY3uHvQ4YupxYX7VGVNL\ndKkGLhkRq10gU7W/DV7CO3bd6gx+2uxHUODCpwxgbnhLE73gxAj6gmv0WVWUfvtF\nWsvdgkop2ssFOT8CcCq5+L7MNkOue0mPJJlsHw2lo4GWnzmPzQs41L1ztlh1cCqF\nCcQHEJ0cemepUZoWKmjjY/o2VQHzQJb438YzmtJYGrVsOjYF42wtpJBVVZ2y9Pd8\ncHuHPG5qo9PXFoZBpNFFQHRkE2J//upQj1K+xwvR3sWHQ0h6AfmYltT7wc8L6+f7\nxg0CAwEAAaNQME4wHQYDVR0OBBYEFG5TRVwz+LthO9Zi8X/m7Jh+grSWMB8GA1Ud\nIwQYMBaAFG5TRVwz+LthO9Zi8X/m7Jh+grSWMAwGA1UdEwQFMAMBAf8wDQYJKoZI\nhvcNAQEFBQADggIBAHMtbdX9BRtxbh6xWW0cHZgW29gr7CtFRtkZZuzA2McwZNT2\np3iqOh3NbmB03xKe0CKuLS0iESOdxFYSKWH6kKkYlGeA6h+PgqergVV4jlQivtha\nOXSsz0TTdRg69mJECHCHB6HqnT78fOka8Dy+UC/JWGjtNMhxtbVe56n1wdvPNK51\nS/ZbsS/JjUfySfwJY1lIiadjM0XeYpHSTVTJtvVVDbk3pdcVkYqTnXnNiWmIKofP\nuwzly5HCX7mcg5OMKG94sBhgHXs2TAcsFsb3a7yPUMDjpTQEcVF85sk27/BuDHyM\n1l/+0VHkyB4ZXUNelz841oV0vJ6m7gMmM6xEXaD3ECHm5cCFmAgzdHtMNy9W7SBl\ni5/mPpuPLUxxym300xQcDfdqg02nfZ1A2JS/sGlmJRiOXAM4Cu/ryChpQ7hPKnr9\nVmGv2pigaWmjdRGjYTneSvuDY3sAiphpxm4qMnzQUpIji3qVxGnTnnU/IuuZa5l6\nZXi/REwyzPOSlpIGW3XFYDs19xfsCcTBBNtWy/WDXj0IGLs4Yt/BocjkFz0hvLdq\nYil94rX1JzpujmIzG6SqdbKrRuvPMu6Ow5YJN9DTlgrjBP8urqO2T92FYx8vMPg2\n5vN+VTePR8sQE3iapCp/N3C/eiVqmah4KZLHE+zv5R8ErBpKE8o4MaKvpYZl\n-----END CERTIFICATE-----",
    "cert_file_name": null,
    "cert_type": 1,
    "cn": "hubbaduba.com",
    "created_at": "2019-07-10T11:54:14.418364",
    "days_left": 364,
    "expired_at": "2020-07-09T11:51:35",
    "host_name": null,
    "issued_at": "2019-07-10T11:51:35",
    "issuer": "C=IN/ST=KA/L=BLR/O=AKA/OU=ENT/CN=hubbadubba.com/emailAddress=email@address.com",
    "modified_at": "2019-07-10T11:54:14.418380",
    "password": "akamai",
    "private_key": "-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIIJjjBABgkqhkiG9w0BBQ0wMzAbBgkqhkiG9w0BBQwwDgQI6l2vpR+MedQCAggA\nMBQGCCqGSIb3DQMHBAg4i0t2gKwtoASCCUjQHSXC8u5nloIOZF7RAq+2quxwypAm\nZj/SzFYl6GAKFEnQQRVyTWIup4fb0EaQsKd75lgAMMvOJ0OMc6VIKUaEIWNZitN4\nuLw2LBVy4FTPys6nKSTAwmcvHW60LMzmN0IFb8g7OuTwz68jFuog1jWUY9O1Bwcd\nWJzgQ0sP/pXKxjqXkGoewGq7AZFh1wV3rQvHUN1i0jQs8x9rzA6etU5+CxPEHVMR\ni098HsNu1Du59bZLfDKwAsARMfFm5OyVpNcqLcnIXAtoKCKJg1jxl8yzZ0iZ4jOn\nNPdZA9nweuqzzrskZvSEh4epAc/Xg9ECt2CNKSA7+NgLBE3X8ZP8j684Wf+TqVGO\ne4sPiA1ZBg+pGdS7bSgITeRgXtWa30br8rq2wJ0FpGLzd6oGJeRl3HYDfMFo6qvU\nEYJa6s1sPsfuFsuwk/fmAv4NGVaqUyxQ/w2N7tCFakX8r+zAYa+Yk9C6mMdKbT+Z\n3EnLkybZnJGPok5elomMl+VIlGJOWHpZAq7d7UAkeGCZHv9KvX2Tv/8oqu6xnVfD\nMkqSafNXpbVpz+qUTFQIaTRR6OjmbcOicA+J4jUCiaOmu+nUCZ8yikh3ZlThcEuO\nzMjjN3cHZnbtZQbH32bfWAwS2YXWmbS7xEoD5QEc7OEewMOqnJmTyxS4NQs1xGcI\nnvaLqVE8u3Xm65/9JKyBOXzvrn55a9ZCA/feNSksUUbqmEPds3F+GhTX3w4QARWt\n3YJTceDxR7TvMtyO5JKj38Tuu4rxLdDCxfCrL0mGSvL7A7nHd9I9lxPr1iM1AxIM\nLGp3cmsqd4+ZY9cOyBsypffmdnT53mrSA1JjLOIwlQX7oV0fDaTIJ+WPycglMChT\nGBc1boHvPejArl0fnw9mNkcT+TGjBupJfZFvOnpF8oYeVUlBWWT2QfcrRiy/qXii\nUkJPrOoJ00sE6gpt8o4zPO87TezS1ngo7lvBYoTIvkS4bhr7tDBuc0kHCCMgIMul\n3qBKIDmKf6ffK4p2geJMVfQlxHOyz0BmWXF3R7abfPBSzisPTmecEbN6tNEpJM+6\n7yBo/scCiESYRfWCHjdYQ5SPMBp6NBbmmIrhV09rzX4BzDCsnAIsLacI73ErdTna\n2I1AEVG9ZVHymrbDZKWIVOMhUOqTI4KfQjWw2wwf1LM6wxBIk0v2hsCNUyr15mHk\n/8hJWn7DYg13H13d+Ej0S+wD2FqcYAMqh08lx5jCeYFsCz4u4dRlHnIENDaH2v7D\n/8X44XOcIs0AL68MYPQr/0W2uOWZ+cakrCySntkBmT8UpVbb2odEGnwMZLYg8uGH\ndjc1hfvYLyxNx5E88AFn9evFE9ZrEWCGQhyab75yrZYNbcX0xDJY/SVWwe4Urjo5\nalgibGxYNFyagvlPVmUqKH4RJBeb8SG6c6X/FpphOwH01EksYi9nI1+ax+ideqiQ\nKKzoHQ/lQoCQsUa/uzY/SRLP0oON6wE56jfycIvqs8oqP4o5kkBohWjeWNcG5szw\nfTrKnRgVymBnFufVxrWOsnTOy9Eywo5693tZ19XmW0qJpg6GT3nBUoTLEkRhTkTg\n8vo8ZUMI6BfezdH+esJVGnlt/uzbZ6sssOUM+74GDVWuqIZe59n9Qj69iGxESujA\nsajwtR6TC8i93tqTiPZoKuVTm8P+rJWZhaEhf+OJyK4nh++fVscEB0M2/pxh9mIt\n8zuxz89xeK3mir879dS600eEbEkNASyAhWVDK1pqZa7TuJhooub1Zg6lPm/16HA2\nYKDu07LtawyCjOj96Fq1Rw3XtygEjvM3XdKADSPyniZrAuR4LZlmhjhnd9I4m/Xu\nBsLCszDBBOOFGJOuWQf10pt0WjglwhahuLD14v9HXdtYa1b/8cYpDBhxVndcIEaW\nGfwvYpTlxKahl8ynrtw5miShaJESIAgpjpxy7qER6WRs2jTfCHWH/9GklI7Xau4f\n2ftQNxXewi61WQPkR+I7k8EZxza36/b+vfEoVgpdTYq1B3qdBiOEI99xoAmmfawu\nPp2orzmtELVxPBXizpE/HdXMsty7zII3yy+alJrHdfnMKwh+yd3Jj3YmGcNd0ISF\nUqFbWlnzZI+iyCSDW4LZ4kV43q9DbGMljipQAWjZJFjsL9BwIBFQMqYW8PzwqY7j\nZJjN4/esrHuRz26lHPNwccoemOyKrcR+sCwz0PR1Afey9Lmf0rCDWshjzhRp8VS1\n9qBOKOiAGyU9C/Ykj8W8B9G0mHa+uSnJ6gDqMa3x605QT43z9kZyf5kpu0VZYE3D\ngsWc2DAin5bhQQvv5pNPpvLnAFWaHtZ1i4K+BHXw/q64geTKIZXPBA+/HZ7OKyPw\nrTwFmZCgyUxNOekaR150ROXvK+2QT3nsfAsAfBSE9//vVSBsJWCvXUJs8dBk0oJh\n4+ZtIpV2cP4VfA2MIfz4FMdjOdbr+WmdhhqK55jqpMKNWS0tbpHjwda0nzigTTQ+\nNpJYtOMSkk3uE7aOKNkKHk6/4LTusfXt9wjcgngeO87QCotc3cTqTGhYUvXlXJlI\nynzr+bhoRR/jiiA1oig3oPm78Q+Row4KnXGHKz9ofPv5TTLkqMrxBUvxNln85AiC\niVJTPXvWJ8/3mQiMGRJh7+719DwmAZ6/f9Z5dL+l9kiQzrdOnG+xNCtFesRBhEoq\nGlP/+W/ewieU0WMDat+QKcHbpIU+HolnJDTXDuDubDaYZszfh1kxm8D8YEb3FcyP\nUrR9eIEsIId3eXGoXAVJ5mrw21VtptHy3bT+Hxbx2E9qTyaLzvKuulKbbXusZ/LI\nJiIv8pjtabQuCfK0BSdTKbPpZx6VnwxZ55SVaK4AoI6+ATx7/vphhDUS0tMDYNmH\nZA1xlciC3k0cxQaqj1UiuqV5p3S41Jd61ROyDR3/+UBmmZc0KtUu2E+Gqa3Nsiom\nDMbdFEk5qa1ar2M55+6Iw4lFcN9qiy3iXsi2BHqr+f7JZMybvgIqPecPtV+tRWPZ\n9LX3z21T2oC6jeFNJAUtBzlBftYDDyzj9ZCF5Hols5EBNcKo55cFBIH1Iy7C4/BD\nDmOUw+Tat+unSDCIXNzd9JwoLHK6WVqFy1A5WL/ZxfCdPt5FGYLTvc6MiZvOvs46\nFf8X6Rg2AcYDMayQFXYqTulFhyVVz829dJ8aZzm3o4/j6z3KWcgeEppBHqVeFAoK\n/Fk=\n-----END ENCRYPTED PRIVATE KEY-----",
    "resource": "certificates",
    "resource_uri": {
        "href": "/api/v1/certificates/Jq2wsVfuRLadm4yMrOT58A"
    },
    "status": 1,
    "subject": "C=IN/ST=KA/L=BLR/O=AKA/OU=ENT/CN=hubbaduba.com/emailAddress=email@address.com",
    "uploaded": null,
    "uuid_url": "Jq2wsVfuRLadm4yMrOT58A"
}

  1. Ensure you have your contractId query parameter.

  2. Build a new certificate object of your desired type.

  3. POST the object to /crux/v1/mgmt-pop/certificates{?contractId}.

  4. Set name to the desired certificate name.

  5. Set password to the certificate password if using a PFX file.

  6. Set cert to .

  7. Set cert_type to 1 for application, 2 for agent, 3 for internal, 4 for user, 5 for self-signed, or 6 for Certificate Authority.

  8. The operation responds with an object containing the certificate.

Get a certificate

Retrieves a single certificate by ID.

GET /crux/v1/mgmt-pop/certificates/{id}{?contractId}

Sample: /crux/v1/mgmt-pop/certificates/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each resource.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: cert_post_response.json

Response body:

{
    "app_count": 0,
    "cert": "-----BEGIN CERTIFICATE-----\nMIIFWjCCA0ICCQD4TZqC/aTsEDANBgkqhkiG9w0BAQsFADBvMQswCQYDVQQGEwJJ\nTjELMAkGA1UECAwCS0ExDDAKBgNVBAcMA0JMUjEMMAoGA1UECgwDQUtBMQwwCgYD\nVQQLDANFTlQxEDAOBgNVBAMMB2FrYS5jb20xFzAVBgkqhkiG9w0BCQEWCGFAdmQu\nY29tMB4XDTE5MDcxMTEwNDAxNloXDTIwMDcxMDEwNDAxNlowbzELMAkGA1UEBhMC\nSU4xCzAJBgNVBAgMAktBMQwwCgYDVQQHDANCTFIxDDAKBgNVBAoMA0FLQTEMMAoG\nA1UECwwDRU5UMRAwDgYDVQQDDAdha2EuY29tMRcwFQYJKoZIhvcNAQkBFghhQHZk\nLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMyTmPMK2PN+hBbq\nGHswnikJl87NKRRm77TlGLNoTxNoy8OynIJLfSim7/xO2jr6UcDT148RfbHzZmIR\nMi1a5/QfvzyeVH0hpdcY5+AJK0gp6QqgsdN2DnST/gJqn/umA0H+pZck6roauOM0\nGTFdizGFYDhMbAVWzzuKlDT5FJ1spgFqNqSGTSt6kfXjVptOPKF0woCQTtRl3Fj6\nD1sx6S9LJQWSQQXlJvvJtIi4lZnBgNTgjoJXrSGkQ9Ektsj7ytBTzDgfKU/PangB\nRdR8Ag6SdVOJT6dD7iE5Gptqv1catm7JbAzOQ64+sEBYh6XmDg18VMs2oQrlo5O3\nKWlx8qruLypDs+RYUyncPtgK5MjXJboTUZLCOmshmq29dfJGfPRmGG6erfpy3hNF\ndcw3Jd3t4aPA3jl7QbhqU8owJi1YXs0bT9QPK5GrpaJvpR5Yi6uPrjwzqsKottmA\neQGXeoM+9r6VDr39qyc+bcdNF8IjIJVrCVN3S16LSQWm7E8L3LP+JS8jQAQcVoay\ngz8qSBmdhkYbxglpbklvYwM8P9KDwSJ01cMWYxZm4GBlXtr6Wg7yzAd/o+7zRK5u\nGeZ/LZPKbqKM/+gWd8dtPLpGUIl4xgVJY5DSK/VHkb6DEsW+vHChj0eI9Y3qkgIJ\nbMm7Rrona6UMAOO7rOXbFVPQDBflAgMBAAEwDQYJKoZIhvcNAQELBQADggIBACSc\nUp47811RIm61uUtA+yBKx47jpcfLg758gJKn9bf0zUa8MOWsQ4DgxXkliuQuaJaR\nkdYdmhAlHyUUh87sb5Ea47Hu8Sl0YqKOWWPBFYpAYoJtNUHzcGnPI8/oQzUMq0qD\nWgM9D6LWK7fDm4S4+D1cHfXYTCVd6CVSD7jXX9DAACSUZsjV+aIcoYox5m5ChyZp\nnTA2c5PtfRA1Cj/2VmJPN55Kb4h03EpkQodJEDCOygzA56DLIkhl814n8yLmTy8M\nuvrZ/zxtsBIpXyMMR5+GZYvuFSOschKnJzlHYv7t57f+60XtJtxZGn/1Plu70Sr0\nvhrCj6uC0DiS3PEjfjl5RyLyxyp84cQ7JXf2WO8o8Y/WlFeQwsjdFDx2tTzxRQ07\nfE8TXZTCeosWbeBk3VWZ8FHtq8dCp7Ied27nO4wvybw/ucKOKXD/eDGOC4wNdZuX\nrHbdh4jvKmuG3nLK2GhE8ZaW3rC+81JZzVcdkuwb6dif+/+E9xgW26pfuPA3O9Yh\njsiRSF0leYAdvuyWwML3T1W2SwxwNPZNwIL7/byOkCLWGIkVW7pDbGl1OYQodPn5\nVsoSbxoPpK2FVEI10hiRk8taT9fTtbKSdXmN6S6k6i5hGbSeGNzxDs0TYkKGUL7T\nHdArfKWqNARzUKpC/COWbdbY8WZb1UBxNtE+Lmf5\n-----END CERTIFICATE-----\n",
    "cert_file_name": "certificate.pfx",
    "cert_type": 1,
    "cn": "aka.com",
    "created_at": "2019-07-11T10:42:30.701478",
    "days_left": 364,
    "description": null,
    "expired_at": "2020-07-10T10:40:16",
    "host_name": null,
    "issued_at": "2019-07-11T10:40:16",
    "issuer": "C=IN/ST=KA/L=BLR/O=AKA/OU=ENT/CN=aka.com/emailAddress=a@vd.com",
    "modified_at": "2019-07-11T10:42:30.701494",
    "name": "bala7@bwrapp.com",
    "password": "akamai",
    "resource": "certificates",
    "resource_uri": {
        "href": "/api/v1/certificates/KscOQO8ZR1qZDBbouTesBQ"
    },
    "status": 1,
    "subject": "C=IN/ST=KA/L=BLR/O=AKA/OU=ENT/CN=aka.com/emailAddress=a@vd.com",
    "uploaded": true,
    "uuid_url": "KscOQO8ZR1qZDBbouTesBQ"
}

  1. Ensure you have your contractId query parameter.

  2. Run the List certificates operation and store the relevant certificate id.

  3. Make a GET request to /crux/v1/mgmt-pop/certificates/{id}{?contractId}.

  4. The operation responds with an object containing the certificate.

Modify a certificate

Updates an existing manual certificate.

PUT /crux/v1/mgmt-pop/certificates/{id}{?contractId}

Sample: /crux/v1/mgmt-pop/certificates/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Content-Type: application/json

Request body:

{
    "status": 1,
    "resource": "certificates",
    "cn": "aka.com",
    "days_left": 361,
    "issuer": "C=IN/ST=KA/L=BLR/O=AKA/OU=ENT/CN=aka.com/emailAddress=a@vd.com",
    "modified_at": "2019-07-12T11:01:42.036932",
    "created_at": "2019-07-12T11:01:42.036917",
    "cert_type": 1,
    "subject": "C=IN/ST=KA/L=BLR/O=AKA/OU=ENT/CN=aka.com/emailAddress=a@vd.com",
    "name": "ew",
    "issued_at": "2019-07-11T10:40:16",
    "cert": "-----BEGIN CERTIFICATE-----\nMIIFYDCCA0gCCQCwmY3OmRBwQTANBgkqhkiG9w0BAQsFADByMQswCQYDVQQGEwJJ\nTjELMAkGA1UECAwCS0ExDDAKBgNVBAcMA0JMUjEMMAoGA1UECgwDQUtBMQwwCgYD\nVQQLDANFTlQxEDAOBgNVBAMMB2FrYS5jb20xGjAYBgkqhkiG9w0BCQEWC2FiY0Bk\nZWMuY29tMB4XDTE5MDcxNTA1MzA1OVoXDTIwMDcxNDA1MzA1OVowcjELMAkGA1UE\nBhMCSU4xCzAJBgNVBAgMAktBMQwwCgYDVQQHDANCTFIxDDAKBgNVBAoMA0FLQTEM\nMAoGA1UECwwDRU5UMRAwDgYDVQQDDAdha2EuY29tMRowGAYJKoZIhvcNAQkBFgth\nYmNAZGVjLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBANUHx86s\n4qGxO3+14DF/S/GJeR130+AJj5KJexTgDdwkYt1R7mgn5Ryp2YHaQeZs8Nple55+\nbPy0lgrlH32rOQGNOlPfwFGrU6mvS8AHTIfyDnki2dlsimd1L1xXUFVDW7rethbZ\nihstY0XsyJ8LFFfuW8m15sjVqWLff8EyAF8YtbtWmzeOwN7xzMh1aINioK6+Bd3i\nSiVrQ7A+bLDsCE9VY+BJof3UbJ15aH2u5EBnxVXa238IdCyDZG2BL/ICpp6Z8w1U\nZPRY2/6VnBWniCnG4TkrzZKjkTEUFspj9R7eBV8mlkblHDjzEHiyrmiXYnL8SiEH\n32sFwgNfd76B7P7Fv/QnpKy4UCr0APMhYSiTOXD1ue4qi3z6aQ/2axI8Lnu3cKPw\nRhe/vBmpgJBcoKI7TQvQhKzdr9debv+WVw01QhJm48TZnwHtdSYObwkDOnegAKRV\nYeZaIHCQ4wexekEAnSOsv1ESCfGrFrg2r7yplKXHuBmiU3ec9Nj0U88uWYzbautq\n+ELW7+lzCBWB+07xuNMfOLEVwl1fhc1wmJHFkVZHQzWk22SOnI42z7OFMrovX8Ou\n95cR/9RVvcV7QDBlBYFmUXSi3HLd3K6OrYZtduVUFXdP5WCMKAmGmGykzXzkjJmt\nNFzbqkNss95byWoq1+8sTjV4VmX0awwut7gbAgMBAAEwDQYJKoZIhvcNAQELBQAD\nggIBAIQW6J4k3LUNOnaHsV+WLs2hf2bTbFnor4YuhpvAKko1qvzebmaa7HcxiXJI\ntzf2eAygDYGqXjjzZB5Mbx5PjotQiMdCktI+sASU5iGoM1iGT89vx75RVFO8KajL\n/sFTZv26w7uSKj4NQEOX1gx5GflauDbbaLhoZM4/CMGw96q2n7oECU3/ZqiSP0r/\nwf+811/V6XwyObqOWV+c9J89UBsKpFGyQ2BZRntAB9Tf3w7vTrZ2EkE4LI4UIAQU\ncH09HbhODWJ7cTb8u3/pY8aWCga5D+UgB6kdisE3Iio+jhiicFRSn97yRDzHk6PA\nY7GLkw/8b1e0hkY3FduSFOsgrUTlMVV54l1B3+RXKrorgfubnSZ1S2l94hzjdaft\nZ6Z5G11Rio/wlVQ/u4hwJlKyXNERxRvXt8IF1UJsuMC/5jSc7al/ZEHfiEk5ajf1\nCB+U99xQlfEf2Gx+U472m1CunM370oKzkdS9MnM66tshvI1RoWbewSlfPq5HHUkF\nyMGMuxNzyzfQa5TURg5Poiif5gnceOZ/8QkuqB2WRUF3DzT+QDh1vhS10bD4rTHy\nv3tItwvOtnOvMSqgrQCCFyEDuTK67TOSOXeIr5ZDnGE/yk0X9+mbbcGeMuN6a987\nQRWWjFz24BtP23TWGiO6GbZ9tinj5bSrQQXFTjQBdJ6y3B8V\n-----END CERTIFICATE-----",
    "app_count": 0,
    "expired_at": "2020-07-10T10:40:16",
    "description": null,
    "password": "akamai",
    "private_key": "-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIIJnzBJBgkqhkiG9w0BBQ0wPDAbBgkqhkiG9w0BBQwwDgQIh90F9F74t6cCAggA\nMB0GCWCGSAFlAwQBKgQQ15odfs2ld0cYTasR7l14GwSCCVBcZ3D0ejBKT5/YvOIU\n2xC/UwvlfAfrGHNh87+kgKmXQ8r3X6nLIwRSw2PWd+0+/N6B2wi4RomocX7/wpq/\n0sIJ7n5buu7aqZvuXhLZrmUrhvg/KQgONr3vSakXuNk43rRO0kTRG8rWvumQI5lN\nkMTTKX2rfmeyQ7GXDZ789GpSAkx+ONYrnweOhB2ePBsBTuKYGP07mqxv/wxRBVLd\nDvL3fB113nMjhP7zET5vtsflJ7gf4T4TqMw55Gtswx8Kvv3O3g2U8iYZAzWZeYfO\nn3Wc/GvAfO3ocsqVG0ToAeLysLHqIqoORfRuZsoUbL0Q2utS/Sftj9n4E/gR42rl\nBpyRmaK3mWwdIOZfqlW6FAEankmyutahTQmM/K2iqUueNRqOLBLSp3T6SGqzKEuH\n8Md5xszaiQX8dq8ODh3pL0qyWSp19sgqz4VHGVIqT/vv5ajWeZel339qcE4Tpvrn\nyf2XVbwei6/EZAn8saRI7cJAp+kfYimUXD2BIfDzXUdieV4tx1TsqTPjRvViymjn\nhV3dd0TcG1DSoUuRP328N0HTKlqHdxIg9Zp6xbRztvDI/yf2iiaoYBWoX8CJHcnI\nwHZCEgFdoZhQWCthsWZ9f9ONQn1X6N6bhcbUwlPyp438w5/W+0jk0xEJPpzZFjfZ\nimlhIQZBqDkfpKQDSK3wSzwwKoaEFGz7waNINwcuM3TLnO5mqLECbzGzoTc3/Myg\nk0rNFAqHyLyCgiwWfW83fC7WLjhcvwMgYiY5rYYXw3IY5za6DRMCdQtdn90tVg7r\njvpjzbpMRPuQD8+bAHemfKp/DklLY6g4eOOAhbiGdWNRsgtP1WE9JSISqEMn8ZRc\nkGennVbeXL5zLuTS9VKsxCrTQ604LVSuvn5WMDvitiUETbp90aPu/jDUY/qiS6dp\nHjnGTJIU/tZ3xC8Pui/Tb8fKcUr+i4KjS0qvaEhiCIuvY2cJ/EwY85VbRti+qj/P\na8bh//p4ykNmIhsOO5EVoBLOq8zjxgTPue5tz6d9n58P4pADrd6taJu4T96m/4NV\ndrOMWJmuUPqVSKN3r54LXd1hvNM99WBBDUd66+ghv4MFe50tlyaIfa1/Or83QFp9\njXJmszTm9Ts0rjrEOXqvCYWD51EnUn4MRbUjlP22woAMlpl3I6t4WRMboqGNe/MK\ne6dynZ3YhKKhrSGQWAQc5gpHYZPXtO3QrQTdERYioph6qptyOjQuoH3piv5koU3V\npbYz5jb7q4cQYL3kueePQgsu5Z1V9ipqwqG9tkEk09BY/61nLLBhe1MM+pVbAYbp\nmCl7arWBpol6vPwMwU3eLuq1B6HxTiLPz2E8V8HEJ6/3uxwkBobIjSgJjeIBGXOC\nhHuvQt+b+/i42w73mpqbLrv1VefH6xBi3Grf3I0LT5Oki3S1suquEcqyl624BuKD\naWfATqW7VNt9tXs+HvSwInRzvhBl9JhB3ENmygxilMXoCtK311KwzGqFw331+jZK\nuBrENVWsK+9NFh3LEGP6R8b9kZkB+diRpZnUK+EZAx8o0A+Ek57jpT4W0TasAoR+\nGVBHZjXJN5sBdLXjraKWetkW8BL9iM1Rk1J933jLTxQoaIrTqnEl7OCP0jYPkj3u\nIyt+uNT3MGoBw6uTMRDCrPJgfDNzRtKPzFACfhOwyjPfXCa6ntr+KVSIjKoEqKii\n640h/CTv9eJw4LXzsdqtZW1Xz80HsJAGoPYf+P/xtJP9PXf4Mn6Kwrl7YA/VzUir\nJraayciGovXeUYzGNW+o+1vZb0AojjV4/usZashv1vsAJmKhLxGP9Qrc7wjZL2mI\n5O/D3go6BIYav0Tj1iDfM+mLlRM9iizNY35luPhY5PlwdVeImU+N8ow37NsCqekO\nixtNGCf26aL629igrXidknL2ZvoEhnYrV5h2PFooR3SKkavIIdijMgwc4fjkEzSv\nyI7qydMZ8azvCpDnO1ox8mzSosVJYkuUVnXxRy5h6P4Rq/iI23cU/2EHPWCMuZZ8\nSCW7KSUgbkdsL9IZbU2aMErtCn0AREAUDp5rcRWU6nBPZFRFd0IY6puRFXwBsEF6\nwgU9M1MbveERoEEn7pok9EvpcVgFIpEhs2kK2ILyN43u5A5O8CaWlEi+kUafIXdj\nlKLp4NGyaNJntDDKePPNykFnEpBxd3UejDxBcofyai/1jfyyxSlPXU05QYdC9b0Y\narZgCC53OIw8B9UqC/ohlqDEqYyUBxJlFKLSUOVN17J/E3+Xmih80aBhKihEAnMB\nr5h+DYl/Y7G5uHEjsjOhWxV/lryvaB5dqbMl8tbFE2z3DVcp8Q8lTE2pz0QbS0SM\nobtQCNkFToN788jHupqFgfsEaKkZ0kCKYem3UAaAgrMrLlFieyBZef66das4o4OL\nDoXXmMFfvGwlz51hk70DjiowFo6W8Ie2Nqyc0BrxYnMHA9bgXCk8Q9EHni1BXggw\nPclk7LA/TqczLC88pTpuyaax2JY6IhBzjpnkgXC20EzjhNOA8E7sPmoPc+yv686e\no11z/GCDiKM5n8sKij71I8WlpbFqup79l1npgTDmtGW0Upc7W1WuMrYp1bQB7Gd2\n8zldWWARRbUcpln+k9cXRfuk6MSPps0qzPZ2J8/zbMQKBOFhfxXhWFztX06djZw6\ndOl3XrtYuTBG2OB6fnobcqfOX+CWqpE2hPus2SuOZE52FhzS6zSL62mlwt9gjNkN\nFJt97nu1T0nzU8rg6LU+U4WhpqTFVFbaT1+1mPQHlwTRjY0tuKzyrDtt53Gnf+nZ\nuXgp1wJG61UnGPYOaZJGObKOFw60OXrSclgjmvBvyAeAUw3GJd0ntwq4DQQOma+V\nminpKpIpq0UU2ww/2ec1FP2Ud4nXZbxfY252O9wQt8+koCDNGGxwpKndzuhXMfrL\nQC9KydEVy0+B9S779yFhA2HSgclKQEzDtG8TkR1/7w/kCYcD54o4X8ZWrjhPRAHm\nx5cNG1Br/5qa1JIo/iyN8io+MzQbTrrQENBXH9JnKUOsvSu9iw/hJisS5/9w7yrr\nvDDyL1tSNQSW9O+gGs2oVgZo6keu9lZsPxZ9rTaAbu9yGJlNCR/U1d+TayUjo20+\n9aX101oV+3/V7/KY4shy+UGCeXFnE7t5Cdq/maC3+q/5esWRhyzXJwffQhtCI7P/\nGkpXLp7xvuDliP8YRY9DtJx8Cg==\n-----END ENCRYPTED PRIVATE KEY-----"
}
Parameter Type Sample Description
URL path parameters
id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each resource.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: cert_post_response.json

Response body:

{
    "app_count": 0,
    "cert": "-----BEGIN CERTIFICATE-----\nMIIFYDCCA0gCCQCwmY3OmRBwQTANBgkqhkiG9w0BAQsFADByMQswCQYDVQQGEwJJ\nTjELMAkGA1UECAwCS0ExDDAKBgNVBAcMA0JMUjEMMAoGA1UECgwDQUtBMQwwCgYD\nVQQLDANFTlQxEDAOBgNVBAMMB2FrYS5jb20xGjAYBgkqhkiG9w0BCQEWC2FiY0Bk\nZWMuY29tMB4XDTE5MDcxNTA1MzA1OVoXDTIwMDcxNDA1MzA1OVowcjELMAkGA1UE\nBhMCSU4xCzAJBgNVBAgMAktBMQwwCgYDVQQHDANCTFIxDDAKBgNVBAoMA0FLQTEM\nMAoGA1UECwwDRU5UMRAwDgYDVQQDDAdha2EuY29tMRowGAYJKoZIhvcNAQkBFgth\nYmNAZGVjLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBANUHx86s\n4qGxO3+14DF/S/GJeR130+AJj5KJexTgDdwkYt1R7mgn5Ryp2YHaQeZs8Nple55+\nbPy0lgrlH32rOQGNOlPfwFGrU6mvS8AHTIfyDnki2dlsimd1L1xXUFVDW7rethbZ\nihstY0XsyJ8LFFfuW8m15sjVqWLff8EyAF8YtbtWmzeOwN7xzMh1aINioK6+Bd3i\nSiVrQ7A+bLDsCE9VY+BJof3UbJ15aH2u5EBnxVXa238IdCyDZG2BL/ICpp6Z8w1U\nZPRY2/6VnBWniCnG4TkrzZKjkTEUFspj9R7eBV8mlkblHDjzEHiyrmiXYnL8SiEH\n32sFwgNfd76B7P7Fv/QnpKy4UCr0APMhYSiTOXD1ue4qi3z6aQ/2axI8Lnu3cKPw\nRhe/vBmpgJBcoKI7TQvQhKzdr9debv+WVw01QhJm48TZnwHtdSYObwkDOnegAKRV\nYeZaIHCQ4wexekEAnSOsv1ESCfGrFrg2r7yplKXHuBmiU3ec9Nj0U88uWYzbautq\n+ELW7+lzCBWB+07xuNMfOLEVwl1fhc1wmJHFkVZHQzWk22SOnI42z7OFMrovX8Ou\n95cR/9RVvcV7QDBlBYFmUXSi3HLd3K6OrYZtduVUFXdP5WCMKAmGmGykzXzkjJmt\nNFzbqkNss95byWoq1+8sTjV4VmX0awwut7gbAgMBAAEwDQYJKoZIhvcNAQELBQAD\nggIBAIQW6J4k3LUNOnaHsV+WLs2hf2bTbFnor4YuhpvAKko1qvzebmaa7HcxiXJI\ntzf2eAygDYGqXjjzZB5Mbx5PjotQiMdCktI+sASU5iGoM1iGT89vx75RVFO8KajL\n/sFTZv26w7uSKj4NQEOX1gx5GflauDbbaLhoZM4/CMGw96q2n7oECU3/ZqiSP0r/\nwf+811/V6XwyObqOWV+c9J89UBsKpFGyQ2BZRntAB9Tf3w7vTrZ2EkE4LI4UIAQU\ncH09HbhODWJ7cTb8u3/pY8aWCga5D+UgB6kdisE3Iio+jhiicFRSn97yRDzHk6PA\nY7GLkw/8b1e0hkY3FduSFOsgrUTlMVV54l1B3+RXKrorgfubnSZ1S2l94hzjdaft\nZ6Z5G11Rio/wlVQ/u4hwJlKyXNERxRvXt8IF1UJsuMC/5jSc7al/ZEHfiEk5ajf1\nCB+U99xQlfEf2Gx+U472m1CunM370oKzkdS9MnM66tshvI1RoWbewSlfPq5HHUkF\nyMGMuxNzyzfQa5TURg5Poiif5gnceOZ/8QkuqB2WRUF3DzT+QDh1vhS10bD4rTHy\nv3tItwvOtnOvMSqgrQCCFyEDuTK67TOSOXeIr5ZDnGE/yk0X9+mbbcGeMuN6a987\nQRWWjFz24BtP23TWGiO6GbZ9tinj5bSrQQXFTjQBdJ6y3B8V\n-----END CERTIFICATE-----",
    "cert_type": 1,
    "cn": "aka.com",
    "created_at": "2019-07-12T11:01:42.036917",
    "days_left": 364,
    "description": null,
    "expired_at": "2020-07-14T05:30:59",
    "issued_at": "2019-07-15T05:30:59",
    "issuer": "C=IN/ST=KA/L=BLR/O=AKA/OU=ENT/CN=aka.com/emailAddress=abc@dec.com",
    "modified_at": "2019-07-15T05:31:39.786610",
    "name": "ew",
    "password": "akamai",
    "private_key": "-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIIJnzBJBgkqhkiG9w0BBQ0wPDAbBgkqhkiG9w0BBQwwDgQIh90F9F74t6cCAggA\nMB0GCWCGSAFlAwQBKgQQ15odfs2ld0cYTasR7l14GwSCCVBcZ3D0ejBKT5/YvOIU\n2xC/UwvlfAfrGHNh87+kgKmXQ8r3X6nLIwRSw2PWd+0+/N6B2wi4RomocX7/wpq/\n0sIJ7n5buu7aqZvuXhLZrmUrhvg/KQgONr3vSakXuNk43rRO0kTRG8rWvumQI5lN\nkMTTKX2rfmeyQ7GXDZ789GpSAkx+ONYrnweOhB2ePBsBTuKYGP07mqxv/wxRBVLd\nDvL3fB113nMjhP7zET5vtsflJ7gf4T4TqMw55Gtswx8Kvv3O3g2U8iYZAzWZeYfO\nn3Wc/GvAfO3ocsqVG0ToAeLysLHqIqoORfRuZsoUbL0Q2utS/Sftj9n4E/gR42rl\nBpyRmaK3mWwdIOZfqlW6FAEankmyutahTQmM/K2iqUueNRqOLBLSp3T6SGqzKEuH\n8Md5xszaiQX8dq8ODh3pL0qyWSp19sgqz4VHGVIqT/vv5ajWeZel339qcE4Tpvrn\nyf2XVbwei6/EZAn8saRI7cJAp+kfYimUXD2BIfDzXUdieV4tx1TsqTPjRvViymjn\nhV3dd0TcG1DSoUuRP328N0HTKlqHdxIg9Zp6xbRztvDI/yf2iiaoYBWoX8CJHcnI\nwHZCEgFdoZhQWCthsWZ9f9ONQn1X6N6bhcbUwlPyp438w5/W+0jk0xEJPpzZFjfZ\nimlhIQZBqDkfpKQDSK3wSzwwKoaEFGz7waNINwcuM3TLnO5mqLECbzGzoTc3/Myg\nk0rNFAqHyLyCgiwWfW83fC7WLjhcvwMgYiY5rYYXw3IY5za6DRMCdQtdn90tVg7r\njvpjzbpMRPuQD8+bAHemfKp/DklLY6g4eOOAhbiGdWNRsgtP1WE9JSISqEMn8ZRc\nkGennVbeXL5zLuTS9VKsxCrTQ604LVSuvn5WMDvitiUETbp90aPu/jDUY/qiS6dp\nHjnGTJIU/tZ3xC8Pui/Tb8fKcUr+i4KjS0qvaEhiCIuvY2cJ/EwY85VbRti+qj/P\na8bh//p4ykNmIhsOO5EVoBLOq8zjxgTPue5tz6d9n58P4pADrd6taJu4T96m/4NV\ndrOMWJmuUPqVSKN3r54LXd1hvNM99WBBDUd66+ghv4MFe50tlyaIfa1/Or83QFp9\njXJmszTm9Ts0rjrEOXqvCYWD51EnUn4MRbUjlP22woAMlpl3I6t4WRMboqGNe/MK\ne6dynZ3YhKKhrSGQWAQc5gpHYZPXtO3QrQTdERYioph6qptyOjQuoH3piv5koU3V\npbYz5jb7q4cQYL3kueePQgsu5Z1V9ipqwqG9tkEk09BY/61nLLBhe1MM+pVbAYbp\nmCl7arWBpol6vPwMwU3eLuq1B6HxTiLPz2E8V8HEJ6/3uxwkBobIjSgJjeIBGXOC\nhHuvQt+b+/i42w73mpqbLrv1VefH6xBi3Grf3I0LT5Oki3S1suquEcqyl624BuKD\naWfATqW7VNt9tXs+HvSwInRzvhBl9JhB3ENmygxilMXoCtK311KwzGqFw331+jZK\nuBrENVWsK+9NFh3LEGP6R8b9kZkB+diRpZnUK+EZAx8o0A+Ek57jpT4W0TasAoR+\nGVBHZjXJN5sBdLXjraKWetkW8BL9iM1Rk1J933jLTxQoaIrTqnEl7OCP0jYPkj3u\nIyt+uNT3MGoBw6uTMRDCrPJgfDNzRtKPzFACfhOwyjPfXCa6ntr+KVSIjKoEqKii\n640h/CTv9eJw4LXzsdqtZW1Xz80HsJAGoPYf+P/xtJP9PXf4Mn6Kwrl7YA/VzUir\nJraayciGovXeUYzGNW+o+1vZb0AojjV4/usZashv1vsAJmKhLxGP9Qrc7wjZL2mI\n5O/D3go6BIYav0Tj1iDfM+mLlRM9iizNY35luPhY5PlwdVeImU+N8ow37NsCqekO\nixtNGCf26aL629igrXidknL2ZvoEhnYrV5h2PFooR3SKkavIIdijMgwc4fjkEzSv\nyI7qydMZ8azvCpDnO1ox8mzSosVJYkuUVnXxRy5h6P4Rq/iI23cU/2EHPWCMuZZ8\nSCW7KSUgbkdsL9IZbU2aMErtCn0AREAUDp5rcRWU6nBPZFRFd0IY6puRFXwBsEF6\nwgU9M1MbveERoEEn7pok9EvpcVgFIpEhs2kK2ILyN43u5A5O8CaWlEi+kUafIXdj\nlKLp4NGyaNJntDDKePPNykFnEpBxd3UejDxBcofyai/1jfyyxSlPXU05QYdC9b0Y\narZgCC53OIw8B9UqC/ohlqDEqYyUBxJlFKLSUOVN17J/E3+Xmih80aBhKihEAnMB\nr5h+DYl/Y7G5uHEjsjOhWxV/lryvaB5dqbMl8tbFE2z3DVcp8Q8lTE2pz0QbS0SM\nobtQCNkFToN788jHupqFgfsEaKkZ0kCKYem3UAaAgrMrLlFieyBZef66das4o4OL\nDoXXmMFfvGwlz51hk70DjiowFo6W8Ie2Nqyc0BrxYnMHA9bgXCk8Q9EHni1BXggw\nPclk7LA/TqczLC88pTpuyaax2JY6IhBzjpnkgXC20EzjhNOA8E7sPmoPc+yv686e\no11z/GCDiKM5n8sKij71I8WlpbFqup79l1npgTDmtGW0Upc7W1WuMrYp1bQB7Gd2\n8zldWWARRbUcpln+k9cXRfuk6MSPps0qzPZ2J8/zbMQKBOFhfxXhWFztX06djZw6\ndOl3XrtYuTBG2OB6fnobcqfOX+CWqpE2hPus2SuOZE52FhzS6zSL62mlwt9gjNkN\nFJt97nu1T0nzU8rg6LU+U4WhpqTFVFbaT1+1mPQHlwTRjY0tuKzyrDtt53Gnf+nZ\nuXgp1wJG61UnGPYOaZJGObKOFw60OXrSclgjmvBvyAeAUw3GJd0ntwq4DQQOma+V\nminpKpIpq0UU2ww/2ec1FP2Ud4nXZbxfY252O9wQt8+koCDNGGxwpKndzuhXMfrL\nQC9KydEVy0+B9S779yFhA2HSgclKQEzDtG8TkR1/7w/kCYcD54o4X8ZWrjhPRAHm\nx5cNG1Br/5qa1JIo/iyN8io+MzQbTrrQENBXH9JnKUOsvSu9iw/hJisS5/9w7yrr\nvDDyL1tSNQSW9O+gGs2oVgZo6keu9lZsPxZ9rTaAbu9yGJlNCR/U1d+TayUjo20+\n9aX101oV+3/V7/KY4shy+UGCeXFnE7t5Cdq/maC3+q/5esWRhyzXJwffQhtCI7P/\nGkpXLp7xvuDliP8YRY9DtJx8Cg==\n-----END ENCRYPTED PRIVATE KEY-----",
    "resource": "certificates",
    "resource_uri": {
        "href": "/api/v1/certificates/FNOUbN-ST2WUvdnz_RFKLw"
    },
    "status": 1,
    "subject": "C=IN/ST=KA/L=BLR/O=AKA/OU=ENT/CN=aka.com/emailAddress=abc@dec.com",
    "uuid_url": "FNOUbN-ST2WUvdnz_RFKLw"
}

  1. Ensure you have your contractId query parameter.

  2. Run the List certificates operation and store the relevant certificate id.

  3. Run the Get a certificate operation and store the response object.

  4. Modify the certificate.

  5. PUT the object to /crux/v1/mgmt-pop/certificates/{id}{?contractId}.

  6. The operation responds with the certificate.

Delete a certificate

Removes an existing certificate.

DELETE /crux/v1/mgmt-pop/certificates/{id}{?contractId}

Sample: /crux/v1/mgmt-pop/certificates/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each resource.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 204

Upload a certificate

Modifies a certificate.

POST /crux/v1/mgmt-pop/certificates/{id}/upload{?contractId}

Sample: /crux/v1/mgmt-pop/certificates/ojxkXzwyQZiBkoRee0XcnA/upload?contractId=F-EMGSGV

Content-Type: application/json

Download schema: cert_post_response.json

Request body:

{
    "cert": "-----BEGIN CERTIFICATE-----\nMIIFyTCCA7GgAwIBAgIJAO3MKqYydvdmMA0GCSqGSIb3DQEBBQUAMHsxCzAJBgNV\nBAYTAklOMQswCQYDVQQIDAJLQTEMMAoGA1UEBwwDQkxSMQwwCgYDVQQKDANBS0Ex\nDDAKBgNVBAsMA0VOVDETMBEGA1UEAwwKYWthbWFpLmNvbTEgMB4GCSqGSIb3DQEJ\nARYRZW1haWxAYWRkcmVzcy5jb20wHhcNMTkwNzEwMTE1MTM1WhcNMjAwNzA5MTE1\nMTM1WjB7MQswCQYDVQQGEwJJTjELMAkGA1UECAwCS0ExDDAKBgNVBAcMA0JMUjEM\nMAoGA1UECgwDQUtBMQwwCgYDVQQLDANFTlQxEzARBgNVBAMMCmFrYW1haS5jb20x\nIDAeBgkqhkiG9w0BCQEWEWVtYWlsQGFkZHJlc3MuY29tMIICIjANBgkqhkiG9w0B\nAQEFAAOCAg8AMIICCgKCAgEAtpxoGy2xBwNWWHhbMwnl4nRP0fefS02h1nAeq9fH\noAeCFhQv2fb7MubWXartEEBemgpR10HZDS9AbiJfVY+7bvmXRmUE2UP7uTySf7V8\nXoZ/vqSwuIQ6K5jcQ1VCzGeisytjAkMfFn2DBujvuEPLeUXet7ZBf/lg9S2VXffP\nXpJ+mflWXUDU72bfXpf1of0gCsb84EYg2SN7GnpOhM8RNULRQ2pwAcnLKHuHDiuJ\n3EtzpbuN+w1rqHBhPWMQY4K1FfHBA8qj8pRSOexzMMJdTYNQ1B1ymrM3zmrNxyjB\nmPFRhGvxPRaUNYiFQIkWI8SZIT3nIWajSDQXkd8N3YtF1Hmctz39/LZ9EM+dHGhH\nuhVHfCLF46604KE3erl/oklORXfC9EPvb7EkUoZeCGDTBY3uHvQ4YupxYX7VGVNL\ndKkGLhkRq10gU7W/DV7CO3bd6gx+2uxHUODCpwxgbnhLE73gxAj6gmv0WVWUfvtF\nWsvdgkop2ssFOT8CcCq5+L7MNkOue0mPJJlsHw2lo4GWnzmPzQs41L1ztlh1cCqF\nCcQHEJ0cemepUZoWKmjjY/o2VQHzQJb438YzmtJYGrVsOjYF42wtpJBVVZ2y9Pd8\ncHuHPG5qo9PXFoZBpNFFQHRkE2J//upQj1K+xwvR3sWHQ0h6AfmYltT7wc8L6+f7\nxg0CAwEAAaNQME4wHQYDVR0OBBYEFG5TRVwz+LthO9Zi8X/m7Jh+grSWMB8GA1Ud\nIwQYMBaAFG5TRVwz+LthO9Zi8X/m7Jh+grSWMAwGA1UdEwQFMAMBAf8wDQYJKoZI\nhvcNAQEFBQADggIBAHMtbdX9BRtxbh6xWW0cHZgW29gr7CtFRtkZZuzA2McwZNT2\np3iqOh3NbmB03xKe0CKuLS0iESOdxFYSKWH6kKkYlGeA6h+PgqergVV4jlQivtha\nOXSsz0TTdRg69mJECHCHB6HqnT78fOka8Dy+UC/JWGjtNMhxtbVe56n1wdvPNK51\nS/ZbsS/JjUfySfwJY1lIiadjM0XeYpHSTVTJtvVVDbk3pdcVkYqTnXnNiWmIKofP\nuwzly5HCX7mcg5OMKG94sBhgHXs2TAcsFsb3a7yPUMDjpTQEcVF85sk27/BuDHyM\n1l/+0VHkyB4ZXUNelz841oV0vJ6m7gMmM6xEXaD3ECHm5cCFmAgzdHtMNy9W7SBl\ni5/mPpuPLUxxym300xQcDfdqg02nfZ1A2JS/sGlmJRiOXAM4Cu/ryChpQ7hPKnr9\nVmGv2pigaWmjdRGjYTneSvuDY3sAiphpxm4qMnzQUpIji3qVxGnTnnU/IuuZa5l6\nZXi/REwyzPOSlpIGW3XFYDs19xfsCcTBBNtWy/WDXj0IGLs4Yt/BocjkFz0hvLdq\nYil94rX1JzpujmIzG6SqdbKrRuvPMu6Ow5YJN9DTlgrjBP8urqO2T92FYx8vMPg2\n5vN+VTePR8sQE3iapCp/N3C/eiVqmah4KZLHE+zv5R8ErBpKE8o4MaKvpYZl\n-----END CERTIFICATE-----",
    "name": "abc@def.com",
    "password": "verygoodpassswrd",
    "private_key": "-----BEGIN ENCRYPTED PRIVATE KEY-----\nMIIJjjBABgkqhkiG9w0BBQ0wMzAbBgkqhkiG9w0BBQwwDgQI6l2vpR+MedQCAggA\nMBQGCCqGSIb3DQMHBAg4i0t2gKwtoASCCUjQHSXC8u5nloIOZF7RAq+2quxwypAm\nZj/SzFYl6GAKFEnQQRVyTWIup4fb0EaQsKd75lgAMMvOJ0OMc6VIKUaEIWNZitN4\nuLw2LBVy4FTPys6nKSTAwmcvHW60LMzmN0IFb8g7OuTwz68jFuog1jWUY9O1Bwcd\nWJzgQ0sP/pXKxjqXkGoewGq7AZFh1wV3rQvHUN1i0jQs8x9rzA6etU5+CxPEHVMR\ni098HsNu1Du59bZLfDKwAsARMfFm5OyVpNcqLcnIXAtoKCKJg1jxl8yzZ0iZ4jOn\nNPdZA9nweuqzzrskZvSEh4epAc/Xg9ECt2CNKSA7+NgLBE3X8ZP8j684Wf+TqVGO\ne4sPiA1ZBg+pGdS7bSgITeRgXtWa30br8rq2wJ0FpGLzd6oGJeRl3HYDfMFo6qvU\nEYJa6s1sPsfuFsuwk/fmAv4NGVaqUyxQ/w2N7tCFakX8r+zAYa+Yk9C6mMdKbT+Z\n3EnLkybZnJGPok5elomMl+VIlGJOWHpZAq7d7UAkeGCZHv9KvX2Tv/8oqu6xnVfD\nMkqSafNXpbVpz+qUTFQIaTRR6OjmbcOicA+J4jUCiaOmu+nUCZ8yikh3ZlThcEuO\nzMjjN3cHZnbtZQbH32bfWAwS2YXWmbS7xEoD5QEc7OEewMOqnJmTyxS4NQs1xGcI\nnvaLqVE8u3Xm65/9JKyBOXzvrn55a9ZCA/feNSksUUbqmEPds3F+GhTX3w4QARWt\n3YJTceDxR7TvMtyO5JKj38Tuu4rxLdDCxfCrL0mGSvL7A7nHd9I9lxPr1iM1AxIM\nLGp3cmsqd4+ZY9cOyBsypffmdnT53mrSA1JjLOIwlQX7oV0fDaTIJ+WPycglMChT\nGBc1boHvPejArl0fnw9mNkcT+TGjBupJfZFvOnpF8oYeVUlBWWT2QfcrRiy/qXii\nUkJPrOoJ00sE6gpt8o4zPO87TezS1ngo7lvBYoTIvkS4bhr7tDBuc0kHCCMgIMul\n3qBKIDmKf6ffK4p2geJMVfQlxHOyz0BmWXF3R7abfPBSzisPTmecEbN6tNEpJM+6\n7yBo/scCiESYRfWCHjdYQ5SPMBp6NBbmmIrhV09rzX4BzDCsnAIsLacI73ErdTna\n2I1AEVG9ZVHymrbDZKWIVOMhUOqTI4KfQjWw2wwf1LM6wxBIk0v2hsCNUyr15mHk\n/8hJWn7DYg13H13d+Ej0S+wD2FqcYAMqh08lx5jCeYFsCz4u4dRlHnIENDaH2v7D\n/8X44XOcIs0AL68MYPQr/0W2uOWZ+cakrCySntkBmT8UpVbb2odEGnwMZLYg8uGH\ndjc1hfvYLyxNx5E88AFn9evFE9ZrEWCGQhyab75yrZYNbcX0xDJY/SVWwe4Urjo5\nalgibGxYNFyagvlPVmUqKH4RJBeb8SG6c6X/FpphOwH01EksYi9nI1+ax+ideqiQ\nKKzoHQ/lQoCQsUa/uzY/SRLP0oON6wE56jfycIvqs8oqP4o5kkBohWjeWNcG5szw\nfTrKnRgVymBnFufVxrWOsnTOy9Eywo5693tZ19XmW0qJpg6GT3nBUoTLEkRhTkTg\n8vo8ZUMI6BfezdH+esJVGnlt/uzbZ6sssOUM+74GDVWuqIZe59n9Qj69iGxESujA\nsajwtR6TC8i93tqTiPZoKuVTm8P+rJWZhaEhf+OJyK4nh++fVscEB0M2/pxh9mIt\n8zuxz89xeK3mir879dS600eEbEkNASyAhWVDK1pqZa7TuJhooub1Zg6lPm/16HA2\nYKDu07LtawyCjOj96Fq1Rw3XtygEjvM3XdKADSPyniZrAuR4LZlmhjhnd9I4m/Xu\nBsLCszDBBOOFGJOuWQf10pt0WjglwhahuLD14v9HXdtYa1b/8cYpDBhxVndcIEaW\nGfwvYpTlxKahl8ynrtw5miShaJESIAgpjpxy7qER6WRs2jTfCHWH/9GklI7Xau4f\n2ftQNxXewi61WQPkR+I7k8EZxza36/b+vfEoVgpdTYq1B3qdBiOEI99xoAmmfawu\nPp2orzmtELVxPBXizpE/HdXMsty7zII3yy+alJrHdfnMKwh+yd3Jj3YmGcNd0ISF\nUqFbWlnzZI+iyCSDW4LZ4kV43q9DbGMljipQAWjZJFjsL9BwIBFQMqYW8PzwqY7j\nZJjN4/esrHuRz26lHPNwccoemOyKrcR+sCwz0PR1Afey9Lmf0rCDWshjzhRp8VS1\n9qBOKOiAGyU9C/Ykj8W8B9G0mHa+uSnJ6gDqMa3x605QT43z9kZyf5kpu0VZYE3D\ngsWc2DAin5bhQQvv5pNPpvLnAFWaHtZ1i4K+BHXw/q64geTKIZXPBA+/HZ7OKyPw\nrTwFmZCgyUxNOekaR150ROXvK+2QT3nsfAsAfBSE9//vVSBsJWCvXUJs8dBk0oJh\n4+ZtIpV2cP4VfA2MIfz4FMdjOdbr+WmdhhqK55jqpMKNWS0tbpHjwda0nzigTTQ+\nNpJYtOMSkk3uE7aOKNkKHk6/4LTusfXt9wjcgngeO87QCotc3cTqTGhYUvXlXJlI\nynzr+bhoRR/jiiA1oig3oPm78Q+Row4KnXGHKz9ofPv5TTLkqMrxBUvxNln85AiC\niVJTPXvWJ8/3mQiMGRJh7+719DwmAZ6/f9Z5dL+l9kiQzrdOnG+xNCtFesRBhEoq\nGlP/+W/ewieU0WMDat+QKcHbpIU+HolnJDTXDuDubDaYZszfh1kxm8D8YEb3FcyP\nUrR9eIEsIId3eXGoXAVJ5mrw21VtptHy3bT+Hxbx2E9qTyaLzvKuulKbbXusZ/LI\nJiIv8pjtabQuCfK0BSdTKbPpZx6VnwxZ55SVaK4AoI6+ATx7/vphhDUS0tMDYNmH\nZA1xlciC3k0cxQaqj1UiuqV5p3S41Jd61ROyDR3/+UBmmZc0KtUu2E+Gqa3Nsiom\nDMbdFEk5qa1ar2M55+6Iw4lFcN9qiy3iXsi2BHqr+f7JZMybvgIqPecPtV+tRWPZ\n9LX3z21T2oC6jeFNJAUtBzlBftYDDyzj9ZCF5Hols5EBNcKo55cFBIH1Iy7C4/BD\nDmOUw+Tat+unSDCIXNzd9JwoLHK6WVqFy1A5WL/ZxfCdPt5FGYLTvc6MiZvOvs46\nFf8X6Rg2AcYDMayQFXYqTulFhyVVz829dJ8aZzm3o4/j6z3KWcgeEppBHqVeFAoK\n/Fk=\n-----END ENCRYPTED PRIVATE KEY-----"
}
Parameter Type Sample Description
URL path parameters
id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each resource.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: cert_post_response.json

Response body:

{
    "cert": "-----BEGIN CERTIFICATE-----\nMIIDYDCCAkgCCQD+HHH0I2iPPjANBgkqhkiG9w0BAQsFADByMQswCQYDVQQGEwJJ\nTjELMAkGA1UECAwCS0ExDDAKBgNVBAcMA0JMUjEMMAoGA1UECgwDQUtBMQwwCgYD\nVQQLDANFTlQxEDAOBgNVBAMMB2FrYS5jb20xGjAYBgkqhkiG9w0BCQEWC2FiY0Bk\nZWYuY29tMB4XDTE5MDcxMTEyMjYxMVoXDTI0MDcwOTEyMjYxMVowcjELMAkGA1UE\nBhMCSU4xCzAJBgNVBAgMAktBMQwwCgYDVQQHDANCTFIxDDAKBgNVBAoMA0FLQTEM\nMAoGA1UECwwDRU5UMRAwDgYDVQQDDAdha2EuY29tMRowGAYJKoZIhvcNAQkBFgth\nYmNAZGVmLmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAO5GKfJ+\ngnAxP2PdzURQ40XxFCQz0nFePdC6iD1uJAT5lqViQxArldBdCsu0E9hl0EHP5+Mn\nvEzisuVMMZXNNCqY+fSAV1GrU6VRW+F3h+XrhkCYU/sVwMqo2P6Phu0pYSayayTp\nQuKjfbUzLd1XFDJObxEA/msp+XjgfBbIukDPHN4mkY6c3xsWOS5u1U+iQp4/ha5E\nNO3ZI0YuhXc4iBkV2YlFFwhvPR3Hd3ML8QvkGHYHtw8QtQRWEJWefxUvk+c/YCtS\n6PLHXT35b5XMNxR31qmWvgPaNGoXfgELyqhv7pIt3EoNzilDGgbcNtdKaq8gX2Yw\nOXd1UsCJDG7e8O8CAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAWEJPA1u0USi8zm1E\nJcU9Oy0r0vUgJurtPehpXrOd7TQd7cr+2F9kfGo58/tm9bpURpNse1Hcpz5XYjdZ\n4pNHK081oJQmMWkm0Yy9Fmd3lMEzgstnC7UckBbK3OdmlUME5JRYNt5IanMuRzZi\ndAJoTVuIKovGM8LWMl1FqKFM52GaVbgiaYlkW8UHWsM3dWgR3xjoNhqTvZdKlFVB\nTsuQ4+lOSo6/zHq5WSlsQW6v0h17ph2KG4F8K69t4lJQCrnyDtvSCT94ncDQ3MMP\nYQT34H06Uf9sqrkfw5uHCzER/kb3vPHVaota32DLhDIbUZ3l0u3Aa8UM13NhAKaX\nIPjLsQ==\n-----END CERTIFICATE-----\n"
}

  1. Ensure you have your contractId query parameter.

  2. Run the List certificates operation and store the relevant certificate id.

  3. Build a new certificate object of your desired type.

  4. Set name to the desired certificate name.

  5. Set password to the certificate password if using a PFX file.

  6. Set cert to the certificate file name.

  7. Set cert_type to 1 for application, 2 for agent, 3 for internal, 4 for user, 5 for self-signed, or 6 for Certificate Authority.

  8. POST the object to /crux/v1/mgmt-pop/certificates/{id}/upload{?contractId}.

  9. The operation responds with an object containing the certificate.

Get CA attributes

Returns CA attributes.

GET /crux/v1/mgmt-pop/certificates/ca_attributes{?contractId}

Sample: /crux/v1/mgmt-pop/certificates/ca_attributes?contractId=F-EMGSGV

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Response body:

[
    "CN",
    "GN",
    "IPSec User",
    "Microsoft Smartcardlogin",
    "Microsoft Universal Principal Name",
    "Permanent Identifier",
    "SN",
    "UID",
    "X509v3 Subject Alternative Name",
    "commonName",
    "distinguishedName",
    "emailAddress",
    "friendlyName",
    "givenName",
    "ipsecUser",
    "mail",
    "msSmartcardLogin",
    "msUPN",
    "name",
    "serialNumber",
    "subjectAltName",
    "surname",
    "uniqueMember",
    "unstructuredAddress",
    "unstructuredName",
    "userId"
]

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/mgmt-pop/certificates/ca_attributes{?contractId}.

  3. The operation responds with a list of available CA attributes.

List connectors

Returns a list of connectors.

GET /crux/v1/mgmt-pop/agents{?contractId,offset,limit}

Sample: /crux/v1/mgmt-pop/agents?contractId=F-EMGSGV&offset=10&limit=30

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Download schema: agents.json

Response body:

{
    "meta": {
        "limit": 10,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 9
    },
    "objects": [
        {
            "advanced_settings": {
                "network_info": [
                    "0.0.0.0/0"
                ]
            },
            "agent_type": 1,
            "agent_upgrade_enabled": true,
            "agent_upgrade_suspended": false,
            "agent_version": null,
            "auth_service": true,
            "capacity": {
                "capacity-multipliers": {
                    "rdp": 2
                },
                "remaining-capacity": 999
            },
            "cpu": null,
            "created_at": "2020-04-27T10:59:52.751874",
            "data_service": true,
            "debug_channel_permitted": true,
            "description": "IDP connector",
            "dhcp": "enabled",
            "disk_size": null,
            "dns_server": null,
            "down_apps_count": 0,
            "down_dir_count": 0,
            "download_url": "https://s3.amazonaws.com/soha-agents-prod/11f77d70-eccb-4ae3-ab3a-e1aab9dda8f0.template?Signature=vLZbtqay15UYxcluMQz%2FASMrnjo%3D&Expires=1590577193&AWSAccessKeyId=AKIAJ6H33WWAXIOUBCNQ",
            "gateway": null,
            "geo_location": null,
            "hostname": null,
            "ip_addr": null,
            "last_checkin": null,
            "load_status": null,
            "logging_settings": "[]",
            "mac": null,
            "manual_override": false,
            "modified_at": "2020-04-27T10:59:53.143317",
            "name": "IDP_connector",
            "os_upgrades_up_to_date": true,
            "os_version": null,
            "package": 3,
            "policy": "M2vY1fQbQpyokVzCMIuw2Q",
            "private_ip": null,
            "public_ip": null,
            "pwd_comments": null,
            "pwdsyncflag": false,
            "ram_size": null,
            "reach": 0,
            "region": null,
            "resource_uri": {
                "href": "/api/v1/agents/0ghE7BU_Q9uSVR0ZPxP7Fg"
            },
            "setpwd_attempt": 1,
            "state": 1,
            "status": 1,
            "subnet": null,
            "tz": null,
            "up_apps_count": 0,
            "up_dir_count": 0,
            "uuid_url": "0ghE7BU_Q9uSVR0ZPxP7Fg"
        },
        {
            "advanced_settings": {
                "network_info": [
                    "0.0.0.0/0"
                ]
            },
            "agent_type": 1,
            "agent_upgrade_enabled": true,
            "agent_upgrade_suspended": false,
            "agent_version": "AGENT-1.1.0-16649\n",
            "auth_service": true,
            "capacity": {
                "capacity-multipliers": {
                    "rdp": 2
                },
                "remaining-capacity": 1000
            },
            "cpu": null,
            "created_at": "2020-08-14T07:28:32.208490",
            "data_service": true,
            "debug_channel_permitted": true,
            "description": " test VM based",
            "dhcp": "enabled",
            "disk_size": null,
            "dns_server": "50.51.1.1",
            "down_apps_count": 0,
            "down_dir_count": 0,
            "download_url": null,
            "gateway": null,
            "geo_location": "Pune (IN)",
            "hostname": "ubuntu",
            "ip_addr": null,
            "last_checkin": "2021-01-15T06:09:05.102467",
            "last_stage_status": 1,
            "last_upgrade_failed_date": null,
            "last_upgrade_failed_in": null,
            "last_upgrade_status": 1,
            "last_upgrade_success_date": "2020-08-14T09:51:58.741456",
            "last_upgrade_success_version": "AGENT-1.1.0-16649.tar.gz",
            "latest_stage_attempt_date": null,
            "latest_stage_attempt_version": null,
            "latest_upgrade_attempt_date": null,
            "latest_upgrade_attempt_state": 1,
            "latest_upgrade_attempt_version": null,
            "load_status": null,
            "logging_settings": "[]",
            "mac": "54:26:96:d5:f8:63",
            "manual_override": false,
            "modified_at": "2020-08-14T09:51:58.781286",
            "name": "VM_Based_connector",
            "os_upgrades_up_to_date": true,
            "os_version": "Linux-4.15.0-45-generic-x86_64-with-Ubuntu-18.04-bionic",
            "package": 1,
            "policy": "M2vY1fQbQpyokVzCMIuw2Q",
            "private_ip": "192.168.1.4",
            "public_ip": "103.208.69.161",
            "pwd_comments": "success",
            "pwdsyncflag": true,
            "ram_size": null,
            "reach": 0,
            "region": "Central",
            "resource_uri": {
                "href": "/api/v1/agents/yvAnl4hkQdGg8unUWdnvyQ"
            },
            "setpwd_attempt": 0,
            "state": 6,
            "status": 1,
            "subnet": null,
            "tz": "Asia/Kolkata",
            "up_apps_count": 0,
            "up_dir_count": 0,
            "uuid_url": "yvAnl4hkQdGg8unUWdnvyQ"
        },
        {
            "advanced_settings": {
                "network_info": [
                    "0.0.0.0/0"
                ]
            },
            "agent_type": 1,
            "agent_upgrade_enabled": true,
            "agent_upgrade_suspended": false,
            "agent_version": "AGENT-4.3.0-2429\n",
            "auth_service": true,
            "capacity": {
                "capacity-multipliers": {
                    "rdp": 2
                },
                "remaining-capacity": 1000
            },
            "cpu": null,
            "created_at": "2020-08-17T16:25:08.136686",
            "data_service": true,
            "debug_channel_permitted": true,
            "description": "DOCKER BASED",
            "dhcp": "enabled",
            "disk_size": null,
            "dns_server": "50.51.1.1",
            "down_apps_count": 0,
            "down_dir_count": 0,
            "download_url": "https://s3.amazonaws.com/soha-agents/e61436a2-e930-4940-969a-835e2c55ebe2.tar.gz?AWSAccessKeyId=AKIAIZN5F3T4EVUKLTGA&Signature=HE0zpLeDyDH4m1V%2BqyQ9elNWQDw%3D&Expires=1602369777",
            "gateway": null,
            "geo_location": "Pune (IN)",
            "hostname": "73f2b26f060b",
            "ip_addr": null,
            "last_checkin": "2020-08-18T11:41:27.891583",
            "last_stage_status": 1,
            "last_upgrade_failed_date": "2020-08-18T11:34:51.672999",
            "last_upgrade_failed_in": null,
            "last_upgrade_status": 4,
            "last_upgrade_success_date": "2020-08-18T11:32:24.551716",
            "last_upgrade_success_version": null,
            "latest_stage_attempt_date": null,
            "latest_stage_attempt_version": null,
            "latest_upgrade_attempt_date": "2020-08-18T11:37:50.840483",
            "latest_upgrade_attempt_state": 3,
            "latest_upgrade_attempt_version": "DOCKER_AGENT-4.4.0-217.tar.gz",
            "load_status": null,
            "logging_settings": "[]",
            "mac": "54:26:96:d5:f8:63",
            "manual_override": false,
            "modified_at": "2021-01-20T19:42:40.185405",
            "name": "DOCKER_BASED_CONNECTOR",
            "os_upgrades_up_to_date": true,
            "os_version": "Linux-4.19.76-linuxkit-x86_64-with-Ubuntu-18.04-bionic",
            "package": 6,
            "policy": "M2vY1fQbQpyokVzCMIuw2Q",
            "private_ip": "172.20.0.2",
            "public_ip": "103.208.71.108",
            "pwd_comments": "success",
            "pwdsyncflag": true,
            "ram_size": null,
            "reach": 0,
            "region": "Central",
            "resource_uri": {
                "href": "/api/v1/agents/qCXgK7ZxQGybd-Fm0XuK2Q"
            },
            "setpwd_attempt": 0,
            "state": 1,
            "status": 1,
            "subnet": null,
            "tz": "Asia/Kolkata",
            "up_apps_count": 0,
            "up_dir_count": 0,
            "uuid_url": "qCXgK7ZxQGybd-Fm0XuK2Q"
        },
        {
            "advanced_settings": {
                "network_info": [
                    "0.0.0.0/0"
                ]
            },
            "agent_type": 1,
            "agent_upgrade_enabled": true,
            "agent_upgrade_suspended": false,
            "agent_version": "AGENT-21.01.0-143\n",
            "auth_service": true,
            "capacity": {
                "capacity-multipliers": {
                    "rdp": 2
                },
                "remaining-capacity": 997
            },
            "cpu": null,
            "created_at": "2020-08-17T16:25:36.254912",
            "data_service": true,
            "debug_channel_permitted": true,
            "description": "AWS BASED",
            "dhcp": "enabled",
            "disk_size": null,
            "dns_server": "50.51.1.1",
            "down_apps_count": 0,
            "down_dir_count": 0,
            "download_url": null,
            "gateway": null,
            "geo_location": "Ashburn (US)",
            "hostname": "ip-10-7-9-200",
            "ip_addr": null,
            "last_checkin": "2021-05-25T14:27:10.471159",
            "last_os_upgrade_attempt_state": null,
            "last_stage_status": 1,
            "last_upgrade_failed_date": null,
            "last_upgrade_failed_in": null,
            "last_upgrade_status": 1,
            "last_upgrade_success_date": "2021-03-25T07:13:43.207245",
            "last_upgrade_success_version": "AGENT-21.01.0-143.tar.gz",
            "latest_available_os_upgrades": [
                {
                    "comments": "",
                    "infosec_url": "",
                    "pkg_versions": [
                        {
                            "package": "dnsmasq",
                            "version": "2.79-1ubuntu0.3"
                        }
                    ],
                    "req_disk_space": 72,
                    "severity": 4,
                    "upgrade_rank": 9
                }
            ],
            "latest_stage_attempt_date": null,
            "latest_stage_attempt_version": null,
            "latest_upgrade_attempt_date": null,
            "latest_upgrade_attempt_state": 1,
            "latest_upgrade_attempt_version": null,
            "load_status": "low",
            "logging_settings": "[]",
            "mac": "54:26:96:d5:f8:63",
            "manual_override": false,
            "modified_at": "2021-03-25T07:13:43.224927",
            "name": "AWS_BASED_CONNECTOR",
            "os_upgrades_up_to_date": false,
            "os_version": "Linux-4.15.0-1034-aws-x86_64-with-Ubuntu-18.04-bionic",
            "package": 3,
            "pending_os_updates": 1,
            "policy": "M2vY1fQbQpyokVzCMIuw2Q",
            "private_ip": "10.7.9.200",
            "public_ip": "23.22.133.179",
            "pwd_comments": "success",
            "pwdsyncflag": true,
            "ram_size": null,
            "reach": 1,
            "region": "Central",
            "resource_uri": {
                "href": "/api/v1/agents/FFTN6jChSVa6G-l9EFNArw"
            },
            "setpwd_attempt": 0,
            "state": 6,
            "status": 1,
            "subnet": null,
            "tz": "America/New_York",
            "up_apps_count": 1,
            "up_dir_count": 0,
            "uuid_url": "FFTN6jChSVa6G-l9EFNArw"
        },
        {
            "advanced_settings": {
                "network_info": [
                    "0.0.0.0/0"
                ]
            },
            "agent_type": 1,
            "agent_upgrade_enabled": true,
            "agent_upgrade_suspended": false,
            "agent_version": null,
            "auth_service": true,
            "capacity": {
                "capacity-multipliers": {
                    "rdp": 2
                },
                "remaining-capacity": 1000
            },
            "cpu": null,
            "created_at": "2021-01-15T06:12:15.148792",
            "data_service": true,
            "debug_channel_permitted": true,
            "description": " VM B ASED",
            "dhcp": "enabled",
            "disk_size": null,
            "dns_server": null,
            "down_apps_count": 0,
            "down_dir_count": 0,
            "download_url": null,
            "gateway": null,
            "geo_location": null,
            "hostname": null,
            "ip_addr": null,
            "last_checkin": null,
            "load_status": null,
            "logging_settings": "[]",
            "mac": null,
            "manual_override": false,
            "modified_at": "2021-01-15T06:12:15.196401",
            "name": "VM_BASED_CONNECTOR_15_JAN_21",
            "os_upgrades_up_to_date": true,
            "os_version": null,
            "package": 1,
            "policy": "M2vY1fQbQpyokVzCMIuw2Q",
            "private_ip": null,
            "public_ip": null,
            "pwd_comments": null,
            "pwdsyncflag": false,
            "ram_size": null,
            "reach": 0,
            "region": null,
            "resource_uri": {
                "href": "/api/v1/agents/y-rOW1hESEaOQ6WkAcQcrQ"
            },
            "setpwd_attempt": 1,
            "state": 0,
            "status": 1,
            "subnet": null,
            "tz": null,
            "up_apps_count": 0,
            "up_dir_count": 0,
            "uuid_url": "y-rOW1hESEaOQ6WkAcQcrQ"
        },
        {
            "advanced_settings": {
                "network_info": [
                    "0.0.0.0/0"
                ]
            },
            "agent_type": 1,
            "agent_upgrade_enabled": true,
            "agent_upgrade_suspended": false,
            "agent_version": null,
            "auth_service": true,
            "capacity": {
                "capacity-multipliers": {
                    "rdp": 2
                },
                "remaining-capacity": 1000
            },
            "cpu": null,
            "created_at": "2021-03-09T10:57:05.895346",
            "data_service": true,
            "debug_channel_permitted": true,
            "description": null,
            "dhcp": "enabled",
            "disk_size": null,
            "dns_server": null,
            "down_apps_count": 0,
            "down_dir_count": 0,
            "download_url": "https://s3.amazonaws.com/soha-agents/4fe76382-2d46-4a50-a8fa-6be638ef6a68.tar.gz?AWSAccessKeyId=AKIAYK2DOW62XBWAXG3E&Signature=A0lCU8SKIL3FxMToJZu2I7hzsbU%3D&Expires=1617880030",
            "gateway": null,
            "geo_location": null,
            "hostname": null,
            "ip_addr": null,
            "last_checkin": null,
            "load_status": null,
            "logging_settings": "[]",
            "mac": null,
            "manual_override": false,
            "modified_at": "2021-03-09T11:07:10.226688",
            "name": "VM_CONNECTOR_9_MARCH_2021",
            "os_upgrades_up_to_date": true,
            "os_version": null,
            "package": 1,
            "policy": "M2vY1fQbQpyokVzCMIuw2Q",
            "private_ip": null,
            "public_ip": null,
            "pwd_comments": null,
            "pwdsyncflag": false,
            "ram_size": null,
            "reach": 0,
            "region": null,
            "resource_uri": {
                "href": "/api/v1/agents/Kqw2CW45RF2dQ6pP7AlRgQ"
            },
            "setpwd_attempt": 1,
            "state": 1,
            "status": 1,
            "subnet": null,
            "tz": null,
            "up_apps_count": 0,
            "up_dir_count": 0,
            "uuid_url": "Kqw2CW45RF2dQ6pP7AlRgQ"
        },
        {
            "advanced_settings": {
                "network_info": [
                    "0.0.0.0/0"
                ]
            },
            "agent_type": 1,
            "agent_upgrade_enabled": true,
            "agent_upgrade_suspended": false,
            "agent_version": null,
            "auth_service": true,
            "capacity": {
                "capacity-multipliers": {
                    "rdp": 2
                },
                "remaining-capacity": 1000
            },
            "cpu": null,
            "created_at": "2021-04-29T09:01:58.575454",
            "data_service": true,
            "debug_channel_permitted": false,
            "description": "VM_WARE",
            "dhcp": "enabled",
            "disk_size": null,
            "dns_server": null,
            "down_apps_count": 0,
            "down_dir_count": 0,
            "download_url": "https://s3.amazonaws.com/soha-agents/12695cb3-f72f-4f53-ba3f-9fa39bb8e39d.tar.gz?AWSAccessKeyId=AKIAYK2DOW62XBWAXG3E&Signature=m0Yf6eNl5E71p7KTsrZ0eDAae9o%3D&Expires=1622279664",
            "gateway": null,
            "geo_location": null,
            "hostname": null,
            "ip_addr": null,
            "last_checkin": null,
            "load_status": null,
            "logging_settings": "[]",
            "mac": null,
            "manual_override": false,
            "modified_at": "2021-04-29T09:14:24.429494",
            "name": "Test_VM_Ware",
            "os_upgrades_up_to_date": true,
            "os_version": null,
            "package": 1,
            "policy": "M2vY1fQbQpyokVzCMIuw2Q",
            "private_ip": null,
            "public_ip": null,
            "pwd_comments": null,
            "pwdsyncflag": false,
            "ram_size": null,
            "reach": 0,
            "region": null,
            "resource_uri": {
                "href": "/api/v1/agents/w9sygVx3RZCoMem1W2exeA"
            },
            "setpwd_attempt": 1,
            "state": 1,
            "status": 1,
            "subnet": null,
            "tz": null,
            "up_apps_count": 0,
            "up_dir_count": 0,
            "uuid_url": "w9sygVx3RZCoMem1W2exeA"
        },
        {
            "advanced_settings": {
                "network_info": [
                    "0.0.0.0/0"
                ]
            },
            "agent_type": 1,
            "agent_upgrade_enabled": true,
            "agent_upgrade_suspended": false,
            "agent_version": null,
            "auth_service": true,
            "capacity": {
                "capacity-multipliers": {
                    "rdp": 2
                },
                "remaining-capacity": 1000
            },
            "cpu": null,
            "created_at": "2021-04-29T09:02:31.424577",
            "data_service": true,
            "debug_channel_permitted": true,
            "description": null,
            "dhcp": "enabled",
            "disk_size": null,
            "dns_server": null,
            "down_apps_count": 0,
            "down_dir_count": 0,
            "download_url": "https://s3.amazonaws.com/soha-agents/1acd3270-189c-429c-8d25-97dbae93779f.tar.gz?AWSAccessKeyId=AKIAYK2DOW62XBWAXG3E&Signature=HxP5KYbp0xdewV35u73px5i35AQ%3D&Expires=1622280317",
            "gateway": null,
            "geo_location": null,
            "hostname": null,
            "ip_addr": null,
            "last_checkin": null,
            "load_status": null,
            "logging_settings": "[]",
            "mac": null,
            "manual_override": false,
            "modified_at": "2021-04-29T09:25:17.341156",
            "name": "TEST_VM_WARE_one",
            "os_upgrades_up_to_date": true,
            "os_version": null,
            "package": 1,
            "policy": "M2vY1fQbQpyokVzCMIuw2Q",
            "private_ip": null,
            "public_ip": null,
            "pwd_comments": null,
            "pwdsyncflag": false,
            "ram_size": null,
            "reach": 0,
            "region": null,
            "resource_uri": {
                "href": "/api/v1/agents/zyPVWqYbQb2DSBGPOKo0Lg"
            },
            "setpwd_attempt": 1,
            "state": 1,
            "status": 1,
            "subnet": null,
            "tz": null,
            "up_apps_count": 0,
            "up_dir_count": 0,
            "uuid_url": "zyPVWqYbQb2DSBGPOKo0Lg"
        },
        {
            "advanced_settings": {
                "network_info": [
                    "0.0.0.0/0"
                ]
            },
            "agent_type": 1,
            "agent_upgrade_enabled": true,
            "agent_upgrade_suspended": false,
            "agent_version": null,
            "auth_service": true,
            "capacity": {
                "capacity-multipliers": {
                    "rdp": 2
                },
                "remaining-capacity": 1000
            },
            "cpu": null,
            "created_at": "2021-05-25T14:22:44.194287",
            "data_service": true,
            "debug_channel_permitted": true,
            "description": "TEST OPEN API",
            "dhcp": "enabled",
            "disk_size": null,
            "dns_server": null,
            "down_apps_count": 0,
            "down_dir_count": 0,
            "download_url": null,
            "gateway": null,
            "geo_location": null,
            "hostname": null,
            "ip_addr": null,
            "last_checkin": null,
            "load_status": null,
            "logging_settings": "[]",
            "mac": null,
            "manual_override": false,
            "modified_at": "2021-05-25T14:22:44.229816",
            "name": "TEST_VM_OPEN_API",
            "os_upgrades_up_to_date": true,
            "os_version": null,
            "package": 1,
            "policy": "M2vY1fQbQpyokVzCMIuw2Q",
            "private_ip": null,
            "public_ip": null,
            "pwd_comments": null,
            "pwdsyncflag": false,
            "ram_size": null,
            "reach": 0,
            "region": null,
            "resource_uri": {
                "href": "/api/v1/agents/5CA1blgXRqmxlMzHC4UCCA"
            },
            "setpwd_attempt": 1,
            "state": 0,
            "status": 1,
            "subnet": null,
            "tz": null,
            "up_apps_count": 0,
            "up_dir_count": 0,
            "uuid_url": "5CA1blgXRqmxlMzHC4UCCA"
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. For pagination, set offset the number of members to skip in the object list.

  3. For a pagination, set limit to specify the maximum number of members to return in the response.

  4. Make a GET request to /crux/v1/mgmt-pop/agents{?contractId,offset,limit}.

  5. The operation responds with a list of Connector objects.

Create a connector

Creates a new connector.

POST /crux/v1/mgmt-pop/agents{?contractId}

Sample: /crux/v1/mgmt-pop/agents?contractId=F-EMGSGV

Content-Type: application/json

Download schema: agents.json

Request body:

{
    "status": 1,
    "auth_service": true,
    "data_service": true,
    "advanced_settings": {
        "network_info": [
            "0.0.0.0/0"
        ]
    },
    "package": 1,
    "name": "TEST_VM_OPEN_API",
    "description": "TEST OPEN API",
    "debug_channel_permitted": true
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Connector

Download schema: agent.json

Response body:

{
    "advanced_settings": {
        "network_info": [
            "0.0.0.0/0"
        ]
    },
    "agent_type": 1,
    "agent_upgrade_enabled": true,
    "agent_upgrade_suspended": false,
    "agent_version": null,
    "auth_service": true,
    "cpu": null,
    "created_at": "2021-05-25T14:22:44.194287",
    "data_service": true,
    "debug_channel_permitted": true,
    "description": "TEST OPEN API",
    "dhcp": "enabled",
    "disk_size": null,
    "dns_server": null,
    "download_url": null,
    "gateway": null,
    "geo_location": null,
    "hostname": null,
    "ip_addr": null,
    "last_checkin": null,
    "load_status": null,
    "logging_settings": "[]",
    "mac": null,
    "manual_override": false,
    "modified_at": "2021-05-25T14:22:44.229816",
    "name": "TEST_VM_OPEN_API",
    "os_upgrades_up_to_date": true,
    "os_version": null,
    "package": 1,
    "policy": "M2vY1fQbQpyokVzCMIuw2Q",
    "private_ip": null,
    "public_ip": null,
    "pwd_comments": null,
    "pwdsyncflag": false,
    "ram_size": null,
    "reach": 0,
    "region": null,
    "resource_uri": {
        "href": "/api/v1/agents/5CA1blgXRqmxlMzHC4UCCA"
    },
    "setpwd_attempt": 1,
    "state": 0,
    "status": 1,
    "subnet": null,
    "tz": null,
    "uuid_url": "5CA1blgXRqmxlMzHC4UCCA"
}

  1. Ensure you have your contractId query parameter.

  2. Build a new Connector object.

  3. POST the object to /crux/v1/mgmt-pop/agents{?contractId}.

  4. The operation responds with a Connector object.

Get a connector

Retrieves a single connector by ID.

GET /crux/v1/mgmt-pop/agents/{id}{?contractId}

Sample: /crux/v1/mgmt-pop/agents/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each connector.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Connector

Download schema: agent.json

Response body:

{
    "advanced_settings": {
        "network_info": [
            "0.0.0.0/0"
        ]
    },
    "agent_type": 1,
    "agent_upgrade_enabled": true,
    "agent_upgrade_suspended": false,
    "agent_version": null,
    "auth_service": true,
    "cpu": null,
    "created_at": "2021-05-25T14:22:44.194287",
    "data_service": true,
    "debug_channel_permitted": true,
    "description": "TEST OPEN API",
    "dhcp": "enabled",
    "disk_size": null,
    "dns_server": null,
    "download_url": null,
    "gateway": null,
    "geo_location": null,
    "hostname": null,
    "ip_addr": null,
    "last_checkin": null,
    "load_status": null,
    "logging_settings": "[]",
    "mac": null,
    "manual_override": false,
    "modified_at": "2021-05-25T14:22:44.229816",
    "name": "TEST_VM_OPEN_API",
    "os_upgrades_up_to_date": true,
    "os_version": null,
    "package": 1,
    "policy": "M2vY1fQbQpyokVzCMIuw2Q",
    "private_ip": null,
    "public_ip": null,
    "pwd_comments": null,
    "pwdsyncflag": false,
    "ram_size": null,
    "reach": 0,
    "region": null,
    "resource_uri": {
        "href": "/api/v1/agents/5CA1blgXRqmxlMzHC4UCCA"
    },
    "setpwd_attempt": 1,
    "state": 0,
    "status": 1,
    "subnet": null,
    "tz": null,
    "uuid_url": "5CA1blgXRqmxlMzHC4UCCA"
}

  1. Ensure you have your contractId query parameter.

  2. Run the List connectors operation and store the relevant connector id.

  3. Make a GET request to /crux/v1/mgmt-pop/agents/{id}{?contractId}.

  4. The operation responds with a Connector object.

Modify a connector

Updates an existing connector.

PUT /crux/v1/mgmt-pop/agents/{id}{?contractId}

Sample: /crux/v1/mgmt-pop/agents/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Content-Type: application/json

Object type: Connector

Download schema: agent.json

Request body:

{
    "advanced_settings": {
        "network_info": [
            "0.0.0.0/0"
        ]
    },
    "agent_type": 1,
    "agent_upgrade_enabled": true,
    "agent_upgrade_suspended": false,
    "agent_version": null,
    "auth_service": true,
    "cpu": null,
    "created_at": "2021-05-25T14:22:44.194287",
    "data_service": true,
    "debug_channel_permitted": true,
    "description": "TEST OPEN API",
    "dhcp": "enabled",
    "disk_size": null,
    "dns_server": null,
    "download_url": "https://s3.amazonaws.com/soha-agents/087aa887-6165-4b3a-926a-93aa909ea293.tar.gz?AWSAccessKeyId=AKIAYK2DOW62XBWAXG3E&Signature=HWzSfaSH7DirZ2BwvnlTE8I1Ezs%3D&Expires=1624545180",
    "gateway": null,
    "geo_location": null,
    "hostname": null,
    "ip_addr": null,
    "last_checkin": null,
    "load_status": null,
    "logging_settings": "[]",
    "mac": null,
    "manual_override": false,
    "modified_at": "2021-05-25T14:33:05.523871",
    "name": "PRASAD_TEST_VM_OPEN_API",
    "os_upgrades_up_to_date": true,
    "os_version": null,
    "package": 1,
    "policy": "M2vY1fQbQpyokVzCMIuw2Q",
    "private_ip": null,
    "public_ip": null,
    "pwd_comments": null,
    "pwdsyncflag": false,
    "ram_size": null,
    "reach": 0,
    "region": null,
    "setpwd_attempt": 1,
    "state": 1,
    "status": 1,
    "subnet": null,
    "tz": null
}
Parameter Type Sample Description
URL path parameters
id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each connector.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Connector

Download schema: agent.json

Response body:

{
    "advanced_settings": {
        "network_info": [
            "0.0.0.0/0"
        ]
    },
    "agent_type": 1,
    "agent_upgrade_enabled": true,
    "agent_upgrade_suspended": false,
    "agent_version": null,
    "auth_service": true,
    "cpu": null,
    "created_at": "2021-05-25T14:22:44.194287",
    "data_service": true,
    "debug_channel_permitted": true,
    "description": "TEST OPEN API",
    "dhcp": "enabled",
    "disk_size": null,
    "dns_server": null,
    "download_url": "https://s3.amazonaws.com/soha-agents/087aa887-6165-4b3a-926a-93aa909ea293.tar.gz?AWSAccessKeyId=AKIAYK2DOW62XBWAXG3E&Signature=HWzSfaSH7DirZ2BwvnlTE8I1Ezs%3D&Expires=1624545180",
    "gateway": null,
    "geo_location": null,
    "hostname": null,
    "ip_addr": null,
    "last_checkin": null,
    "load_status": null,
    "logging_settings": "[]",
    "mac": null,
    "manual_override": false,
    "modified_at": "2021-05-25T14:35:17.816611",
    "name": "TEST_VM_OPEN_API",
    "os_upgrades_up_to_date": true,
    "os_version": null,
    "package": 1,
    "policy": "M2vY1fQbQpyokVzCMIuw2Q",
    "private_ip": null,
    "public_ip": null,
    "pwd_comments": null,
    "pwdsyncflag": false,
    "ram_size": null,
    "reach": 0,
    "region": null,
    "resource_uri": {
        "href": "/api/v1/agents/5CA1blgXRqmxlMzHC4UCCA"
    },
    "setpwd_attempt": 1,
    "state": 1,
    "status": 1,
    "subnet": null,
    "tz": null,
    "uuid_url": "5CA1blgXRqmxlMzHC4UCCA"
}

  1. Ensure you have your contractId query parameter.

  2. Run the List connectors operation and store the relevant connector id.

  3. Run the Get a connector operation and store the response object.

  4. Modify the Connector object.

  5. PUT the object to /crux/v1/mgmt-pop/agents/{id}{?contractId}.

  6. The operation responds with a Connector object.

Delete a connector

Deletes an existing connector.

DELETE /crux/v1/mgmt-pop/agents/{id}{?contractId}

Sample: /crux/v1/mgmt-pop/agents/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each connector.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 204

Approve a connector

Approves a connector.

POST /crux/v1/mgmt-pop/agents/{id}/approve{?contractId}

Sample: /crux/v1/mgmt-pop/agents/ojxkXzwyQZiBkoRee0XcnA/approve?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each connector.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Connector

Download schema: agent.json

Response body:

{
    "message": "Connector approved"
}

  1. Ensure you have your contractId query parameter.

  2. Run the List connectors operation and store the relevant connector id.

  3. Make a POST request to /crux/v1/mgmt-pop/agents/{id}/approve{?contractId}.

  4. The operation responds with an object containing a success or failure message.

List directories

Gets a list of directories.

GET /crux/v1/mgmt-pop/directories{?contractId,offset,limit,expand}

Sample: /crux/v1/mgmt-pop/directories?contractId=F-EMGSGV&offset=10&limit=30&expand=true

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: Directory

Download schema: directories.json

Response body:

{
    "meta": {
        "previous": null,
        "total_count": 10,
        "offset": 0,
        "limit": 1000,
        "next": null
    },
    "objects": [
        {
            "mfa": "off",
            "ou_filter": null,
            "user_display_name": "displayName",
            "user_search_filter": "(&(objectClass=user)(objectClass=person))",
            "group_object_classes": [
                "group",
                "groupOfNames"
            ],
            "group_name": "cn",
            "password_change_allow": false,
            "agents": [],
            "group_search_filter": "(objectClass=group)",
            "group_base_dn": "",
            "directory_status": 3,
            "port": 636,
            "group_token": "primaryGroupToken",
            "ou_attr": "",
            "sync_interval": 21600,
            "user_count": 15,
            "service": 6,
            "resource_uri": {
                "href": "/api/v1/directories/BPmiD2v8T263qkWt3OEM6A",
                "users": "/api/v1/directories/BPmiD2v8T263qkWt3OEM6A/users/",
                "groups": "/api/v1/directories/BPmiD2v8T263qkWt3OEM6A/groups/"
            },
            "signed_request": false,
            "sync_state": 1,
            "root_dn": "",
            "auth_response_encrypt": false,
            "company_id": "",
            "logout_url": "",
            "user_memberof": "memberOf",
            "nameidformat": "",
            "uuid_url": "BPmiD2v8T263qkWt3OEM6A",
            "api_key": "",
            "user_fname": "givenName",
            "conf_state": 1,
            "metadata": "",
            "auth_request_signed": false,
            "admin_user": "",
            "user_samaccountname": "sAMAccountName",
            "description": "",
            "password_policy_default": "",
            "group_members": "member",
            "user_upn": "userPrincipalName",
            "dialin_sni": "",
            "ssl": true,
            "group_count": 2,
            "global_catalog": false,
            "password_expire_warn_threshold": 0,
            "kerb_realms": [],
            "ou_object_classes": [
                "organizationalUnit"
            ],
            "user_memberuid": "memberUid",
            "user_lname": "sn",
            "chase_referral": false,
            "schema_attributes": "{}",
            "password_complexity_message": "",
            "password_change_threshold": 0,
            "resource": "directories",
            "name": "Cloud Directory",
            "user_phone_num": "telephoneNumber",
            "user_base_dn": "",
            "created_at": "2017-07-20T09:24:51.951381",
            "server_cert_validate": true,
            "modified_at": "2018-05-18T04:37:31.487944",
            "host": "",
            "attribute_map": {
                "user.phoneNumber": "cloud.phone_number",
                "user.countryCode": "cloud.country_code",
                "user.email": "cloud.email",
                "user.lastName": "cloud.last_name",
                "user.firstName": "cloud.first_name",
                "user.netbios": "cloud.netbios",
                "user.persistentId": "cloud.uuid",
                "user.samAccountName": "cloud.samaccountname",
                "user.userPrincipleName": "cloud.user_principle_name"
            },
            "last_sync": "2017-07-20T09:24:51.951479",
            "user_object_classes": [
                "person",
                "organizationalPerson",
                "user",
                "inetOrgPerson"
            ],
            "cname": "",
            "status": 1,
            "domains": [],
            "user_principal": "sAMAccountName",
            "password_filter": {},
            "directory_type": 1,
            "user_email": "mail",
            "password_reset_allow": false
        },
        {
            "mfa": "off",
            "ou_filter": "",
            "user_display_name": "displayName",
            "user_search_filter": "(&(objectClass=user)(objectClass=person))",
            "group_object_classes": [
                "group",
                "groupOfNames"
            ],
            "group_name": "cn",
            "password_change_allow": true,
            "agents": [
                {
                    "name": "Alok-Qa-Wapp-Alpha-Connector-N-California",
                    "uuid_url": "I1QHNAjzQ6KpQiivF5bxGw"
                },
                {
                    "name": "Alok_OCSP_Ohio",
                    "uuid_url": "ChQHbBiZT_-mwowz2WvLTA"
                }
            ],
            "group_search_filter": "(objectClass=group)",
            "group_base_dn": "dc=eaatest,dc=daredevils,dc=com",
            "directory_status": 5,
            "port": 636,
            "group_token": "primaryGroupToken",
            "ou_attr": "",
            "sync_interval": 21600,
            "user_count": 204,
            "service": 1,
            "resource_uri": {
                "href": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw",
                "users": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/users/",
                "groups": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/groups/"
            },
            "signed_request": false,
            "sync_state": 1,
            "root_dn": "eaatest.daredevils.com",
            "auth_response_encrypt": false,
            "company_id": "",
            "logout_url": "",
            "user_memberof": "memberOf",
            "nameidformat": "",
            "uuid_url": "aAgAKK45R6-uLK5U8o2iKw",
            "api_key": "",
            "user_fname": "givenName",
            "conf_state": 1,
            "metadata": "",
            "auth_request_signed": false,
            "admin_user": "EAATEST\\administrator",
            "user_samaccountname": "sAMAccountName",
            "description": "",
            "password_policy_default": "dc=eaatest,dc=daredevils,dc=com",
            "group_members": "member",
            "user_upn": "userPrincipalName",
            "dialin_sni": "dir-aagakk45r6-ulk5u8o2ikw.login.dialin.stage.akamai-access.com",
            "ssl": true,
            "group_count": 5,
            "global_catalog": false,
            "password_expire_warn_threshold": 0,
            "kerb_realms": [],
            "ou_object_classes": [
                "organizationalUnit"
            ],
            "user_memberuid": "memberUid",
            "user_lname": "sn",
            "chase_referral": false,
            "schema_attributes": "{}",
            "password_complexity_message": "",
            "password_change_threshold": 0,
            "resource": "directories",
            "name": "EAATEST Directory",
            "user_phone_num": "telephoneNumber",
            "user_base_dn": "dc=eaatest,dc=daredevils,dc=com",
            "created_at": "2017-10-30T06:57:39.221798",
            "server_cert_validate": true,
            "modified_at": "2019-07-22T07:14:56.285600",
            "host": "172.31.3.107",
            "attribute_map": {
                "user.phoneNumber": "telephoneNumber",
                "eaa.demo": "departmentNumber",
                "user.firstName": "givenName",
                "user.userName": "sAMAccountName",
                "user.email": "email",
                "user.lastName": "sn",
                "user.groups": "memberOf",
                "eaa.test": "description",
                "user.netbios": "msDS-PrincipalName",
                "user.persistentId": "objectGUID",
                "user.samAccountName": "sAMAccountName",
                "user.countryCode": "countryCode",
                "user.userPrincipleName": "userPrincipalName"
            },
            "last_sync": "2019-07-22T07:14:56.285286",
            "user_object_classes": [
                "person",
                "organizationalPerson",
                "user",
                "inetOrgPerson"
            ],
            "cname": "dir-aagakk45r6-ulk5u8o2ikw.login.stage.akamai-access.com",
            "status": 1,
            "domains": [],
            "user_principal": "userPrincipalName",
            "password_filter": {},
            "directory_type": 2,
            "user_email": "mail",
            "password_reset_allow": true
        },
        {
            "mfa": "off",
            "ou_filter": "",
            "user_display_name": "displayName",
            "user_search_filter": "(&(objectClass=inetOrgPerson)(objectClass=posixAccount))",
            "group_object_classes": [
                "group",
                "groupOfNames"
            ],
            "group_name": "cn",
            "password_change_allow": true,
            "agents": [
                {
                    "name": "Alok_OCSP_Ohio",
                    "uuid_url": "ChQHbBiZT_-mwowz2WvLTA"
                }
            ],
            "group_search_filter": "(|(objectClass=posixGroup)(objectClass=groupOfNames))",
            "group_base_dn": "dc=testpwm,dc=stage,dc=sohacloud,dc=net",
            "directory_status": 5,
            "port": 389,
            "group_token": "gidNumber",
            "ou_attr": "",
            "sync_interval": 21600,
            "user_count": 7,
            "service": 2,
            "resource_uri": {
                "href": "/api/v1/directories/KJNFO6zkQBO_w9T3rqzE1A",
                "users": "/api/v1/directories/KJNFO6zkQBO_w9T3rqzE1A/users/",
                "groups": "/api/v1/directories/KJNFO6zkQBO_w9T3rqzE1A/groups/"
            },
            "signed_request": false,
            "sync_state": 1,
            "root_dn": "testpwm.stage.sohacloud.net",
            "auth_response_encrypt": false,
            "company_id": "",
            "logout_url": "",
            "user_memberof": "gidNumber",
            "nameidformat": "",
            "uuid_url": "KJNFO6zkQBO_w9T3rqzE1A",
            "api_key": "",
            "user_fname": "givenName",
            "conf_state": 1,
            "metadata": "",
            "auth_request_signed": false,
            "admin_user": "cn=admin,dc=testpwm,dc=stage,dc=sohacloud,dc=net",
            "user_samaccountname": "uid",
            "description": "",
            "password_policy_default": "cn=DefaultPPolicy,ou=Policies,dc=testpwm,dc=stage,dc=sohacloud,dc=net",
            "group_members": "member",
            "user_upn": "userPrincipalName",
            "dialin_sni": "anag-kjnfo6zkqbo_w9t3rqze1a.login.dialin.stage.akamai-access.com",
            "ssl": false,
            "group_count": 1,
            "global_catalog": false,
            "password_expire_warn_threshold": 100,
            "kerb_realms": [],
            "ou_object_classes": [
                "organizationalUnit"
            ],
            "user_memberuid": "memberUid",
            "user_lname": "sn",
            "chase_referral": false,
            "schema_attributes": "{}",
            "password_complexity_message": "Password should be minimum 10 Characters and 2 special symbols and 5 numbers",
            "password_change_threshold": 310,
            "resource": "directories",
            "name": "LDAP_Bala",
            "user_phone_num": "telephoneNumber",
            "user_base_dn": "dc=testpwm,dc=stage,dc=sohacloud,dc=net",
            "created_at": "2017-11-02T12:15:23.252175",
            "server_cert_validate": true,
            "modified_at": "2019-07-22T06:14:40.888859",
            "host": "testpwm.stage.sohacloud.net",
            "attribute_map": {
                "user.phoneNumber": "telephoneNumber",
                "user.countryCode": "countryCode",
                "user.firstName": "givenName",
                "user.email": "mail",
                "user.lastName": "sn",
                "user.groups": "member",
                "user.netbios": "",
                "user.persistentId": "entryUUID",
                "user.samAccountName": "uid",
                "user.userPrincipleName": "userPrincipalName"
            },
            "last_sync": "2019-07-22T06:14:40.888600",
            "user_object_classes": [
                "person",
                "organizationalPerson",
                "user",
                "inetOrgPerson"
            ],
            "cname": "anag-kjnfo6zkqbo_w9t3rqze1a.login.stage.akamai-access.com",
            "status": 1,
            "domains": [],
            "user_principal": "mail",
            "password_filter": {},
            "directory_type": 2,
            "user_email": "mail",
            "password_reset_allow": true
        },
        {
            "mfa": "off",
            "ou_filter": "",
            "user_display_name": "displayName",
            "user_search_filter": "(&(objectClass=user)(objectClass=person))",
            "group_object_classes": [
                "group",
                "groupOfNames"
            ],
            "group_name": "cn",
            "password_change_allow": false,
            "agents": [
                {
                    "name": "Alok-AkamaiNetwork-VirutalBox-Connector",
                    "uuid_url": "o1HqJmS7RxydMyKAX1VDqQ"
                }
            ],
            "group_search_filter": "(objectClass=group)",
            "group_base_dn": "dc=alpha,dc=eaatest,dc=com",
            "directory_status": 5,
            "port": 389,
            "group_token": "primaryGroupToken",
            "ou_attr": "",
            "sync_interval": 21600,
            "user_count": 35,
            "service": 1,
            "resource_uri": {
                "href": "/api/v1/directories/SXvrMsR4R8e06SVGQkLfOg",
                "users": "/api/v1/directories/SXvrMsR4R8e06SVGQkLfOg/users/",
                "groups": "/api/v1/directories/SXvrMsR4R8e06SVGQkLfOg/groups/"
            },
            "signed_request": false,
            "sync_state": 1,
            "root_dn": "alpha.eaatest.com",
            "auth_response_encrypt": false,
            "company_id": "",
            "logout_url": "",
            "user_memberof": "memberOf",
            "nameidformat": null,
            "uuid_url": "SXvrMsR4R8e06SVGQkLfOg",
            "api_key": "",
            "user_fname": "givenName",
            "conf_state": 1,
            "metadata": "",
            "auth_request_signed": false,
            "admin_user": "ALPHA-EAATEST\\Administrator",
            "user_samaccountname": "sAMAccountName",
            "description": "",
            "password_policy_default": "",
            "group_members": "member",
            "user_upn": "userPrincipalName",
            "dialin_sni": "dir-sxvrmsr4r8e06svgqklfog.login.dialin.stage.akamai-access.com",
            "ssl": false,
            "group_count": 1,
            "global_catalog": false,
            "password_expire_warn_threshold": 0,
            "kerb_realms": [],
            "ou_object_classes": [
                "organizationalUnit"
            ],
            "user_memberuid": "memberUid",
            "user_lname": "sn",
            "chase_referral": false,
            "schema_attributes": "{}",
            "password_complexity_message": "",
            "password_change_threshold": 0,
            "resource": "directories",
            "name": "Lan's AD",
            "user_phone_num": "telephoneNumber",
            "user_base_dn": "dc=alpha,dc=eaatest,dc=com",
            "created_at": "2018-05-03T05:40:14.687304",
            "server_cert_validate": true,
            "modified_at": "2019-07-22T06:14:41.095977",
            "host": "198.18.226.105",
            "attribute_map": {
                "user.phoneNumber": "telephoneNumber",
                "user.countryCode": "countryCode",
                "user.firstName": "givenName",
                "user.email": "mail",
                "user.lastName": "sn",
                "user.groups": "memberOf",
                "user.netbios": "msDS-PrincipalName",
                "user.persistentId": "objectGUID",
                "user.samAccountName": "sAMAccountName",
                "user.userPrincipleName": "userPrincipalName"
            },
            "last_sync": "2019-07-22T06:14:41.095716",
            "user_object_classes": [
                "person",
                "organizationalPerson",
                "user",
                "inetOrgPerson"
            ],
            "cname": "dir-sxvrmsr4r8e06svgqklfog.login.stage.akamai-access.com",
            "status": 1,
            "domains": [],
            "user_principal": "userPrincipalName",
            "password_filter": {},
            "directory_type": 2,
            "user_email": "mail",
            "password_reset_allow": false
        },
        {
            "mfa": "off",
            "ou_filter": "",
            "user_display_name": "displayName",
            "user_search_filter": "(&(objectClass=user)(objectClass=person))",
            "group_object_classes": [
                "group",
                "groupOfNames"
            ],
            "group_name": "cn",
            "password_change_allow": false,
            "agents": [
                {
                    "name": "Alok-AkamaiNetwork-VirutalBox-Connector",
                    "uuid_url": "o1HqJmS7RxydMyKAX1VDqQ"
                }
            ],
            "group_search_filter": "(objectClass=group)",
            "group_base_dn": "dc=sanjose,dc=pelicancloud,dc=com",
            "directory_status": 5,
            "port": 389,
            "group_token": "primaryGroupToken",
            "ou_attr": "",
            "sync_interval": 21600,
            "user_count": 1364,
            "service": 1,
            "resource_uri": {
                "href": "/api/v1/directories/8hh9mYrlQdSDsFyJXPYWjQ",
                "users": "/api/v1/directories/8hh9mYrlQdSDsFyJXPYWjQ/users/",
                "groups": "/api/v1/directories/8hh9mYrlQdSDsFyJXPYWjQ/groups/"
            },
            "signed_request": false,
            "sync_state": 1,
            "root_dn": "sanjose.pelicancloud.com",
            "auth_response_encrypt": false,
            "company_id": "",
            "logout_url": "",
            "user_memberof": "memberOf",
            "nameidformat": "",
            "uuid_url": "8hh9mYrlQdSDsFyJXPYWjQ",
            "api_key": "",
            "user_fname": "givenName",
            "conf_state": 1,
            "metadata": "",
            "auth_request_signed": false,
            "admin_user": "pelican\\administrator",
            "user_samaccountname": "sAMAccountName",
            "description": "",
            "password_policy_default": "",
            "group_members": "member",
            "user_upn": "userPrincipalName",
            "dialin_sni": "anag-8hh9myrlqdsdsfyjxpywjq.login.dialin.stage.akamai-access.com",
            "ssl": false,
            "group_count": 3,
            "global_catalog": false,
            "password_expire_warn_threshold": 0,
            "kerb_realms": [],
            "ou_object_classes": [
                "organizationalUnit"
            ],
            "user_memberuid": "memberUid",
            "user_lname": "sn",
            "chase_referral": false,
            "schema_attributes": "{}",
            "password_complexity_message": "",
            "password_change_threshold": 0,
            "resource": "directories",
            "name": "Sanjose-Pelicancloud-Com-AD",
            "user_phone_num": "telephoneNumber",
            "user_base_dn": "dc=sanjose,dc=pelicancloud,dc=com",
            "created_at": "2018-05-30T21:55:30.841554",
            "server_cert_validate": true,
            "modified_at": "2019-07-22T06:29:40.977263",
            "host": "ns1.pelicancloud.com",
            "attribute_map": {
                "user.phoneNumber": "telephoneNumber",
                "user.countryCode": "countryCode",
                "user.firstName": "givenName",
                "user.email": "mail",
                "user.lastName": "sn",
                "user.groups": "memberOf",
                "user.netbios": "msDS-PrincipalName",
                "user.persistentId": "objectGUID",
                "user.samAccountName": "sAMAccountName",
                "user.userPrincipleName": "userPrincipalName"
            },
            "last_sync": "2019-07-22T06:29:40.976969",
            "user_object_classes": [
                "person",
                "organizationalPerson",
                "user",
                "inetOrgPerson"
            ],
            "cname": "anag-8hh9myrlqdsdsfyjxpywjq.login.stage.akamai-access.com",
            "status": 1,
            "domains": [],
            "user_principal": "sAMAccountName",
            "password_filter": {},
            "directory_type": 2,
            "user_email": "mail",
            "password_reset_allow": false
        },
        {
            "mfa": "off",
            "ou_filter": "",
            "user_display_name": "displayName",
            "user_search_filter": "(&(objectClass=user)(objectClass=person))",
            "group_object_classes": [
                "group",
                "groupOfNames"
            ],
            "group_name": "cn",
            "password_change_allow": true,
            "agents": [
                {
                    "name": "anag-1804-aws-agent",
                    "uuid_url": "ikbBcyKGSfmFbRaL8zrslA"
                }
            ],
            "group_search_filter": "(objectClass=group)",
            "group_base_dn": "dc=eaatest,dc=daredevils,dc=com",
            "directory_status": 5,
            "port": 636,
            "group_token": "primaryGroupToken",
            "ou_attr": "",
            "sync_interval": 1209600,
            "user_count": 37,
            "service": 1,
            "resource_uri": {
                "href": "/api/v1/directories/1XNQZptvRTWCzkmWlgcXwQ",
                "users": "/api/v1/directories/1XNQZptvRTWCzkmWlgcXwQ/users/",
                "groups": "/api/v1/directories/1XNQZptvRTWCzkmWlgcXwQ/groups/"
            },
            "signed_request": false,
            "sync_state": 1,
            "root_dn": "eaatest.daredevils.com",
            "auth_response_encrypt": false,
            "company_id": "",
            "logout_url": "",
            "user_memberof": "memberOf",
            "nameidformat": "",
            "uuid_url": "1XNQZptvRTWCzkmWlgcXwQ",
            "api_key": "",
            "user_fname": "givenName",
            "conf_state": 1,
            "metadata": "",
            "auth_request_signed": false,
            "admin_user": "EAATEST\\Administrator",
            "user_samaccountname": "sAMAccountName",
            "description": "",
            "password_policy_default": "dc=eaatest,dc=daredevils,dc=com",
            "group_members": "member",
            "user_upn": "userPrincipalName",
            "dialin_sni": "dir-1xnqzptvrtwczkmwlgcxwq.login.dialin.stage.akamai-access.com",
            "ssl": true,
            "group_count": 4,
            "global_catalog": false,
            "password_expire_warn_threshold": 3600,
            "kerb_realms": [],
            "ou_object_classes": [
                "organizationalUnit"
            ],
            "user_memberuid": "memberUid",
            "user_lname": "sn",
            "chase_referral": false,
            "schema_attributes": "{}",
            "password_complexity_message": "Password must contain at least eight characters and one number.Hello",
            "password_change_threshold": 3600,
            "resource": "directories",
            "name": "EaaTest Directory Alpha",
            "user_phone_num": "telephoneNumber",
            "user_base_dn": "dc=eaatest,dc=daredevils,dc=com",
            "created_at": "2018-10-04T10:57:18.016370",
            "server_cert_validate": true,
            "modified_at": "2019-07-19T11:59:37.624600",
            "host": "52.14.222.206",
            "attribute_map": {
                "user.phoneNumber": "telephoneNumber",
                "user.countryCode": "countryCode",
                "user.firstName": "givenName",
                "user.email": "mail",
                "user.lastName": "sn",
                "user.groups": "memberOf",
                "user.netbios": "msDS-PrincipalName",
                "user.persistentId": "objectGUID",
                "user.samAccountName": "sAMAccountName",
                "user.userPrincipleName": "userPrincipalName"
            },
            "last_sync": "2019-07-19T11:59:37.624427",
            "user_object_classes": [
                "person",
                "organizationalPerson",
                "user",
                "inetOrgPerson"
            ],
            "cname": "dir-1xnqzptvrtwczkmwlgcxwq.login.stage.akamai-access.com",
            "status": 1,
            "domains": [],
            "user_principal": "userPrincipalName",
            "password_filter": {},
            "directory_type": 2,
            "user_email": "mail",
            "password_reset_allow": true
        },
        {
            "mfa": "off",
            "ou_filter": "",
            "user_display_name": "displayName",
            "user_search_filter": "(&(objectClass=user)(objectClass=person))",
            "group_object_classes": [
                "group",
                "groupOfNames"
            ],
            "group_name": "cn",
            "password_change_allow": false,
            "agents": [
                {
                    "name": "Alok-Qa-Wapp-Alpha-Connector-N-California",
                    "uuid_url": "I1QHNAjzQ6KpQiivF5bxGw"
                }
            ],
            "group_search_filter": "(objectClass=group)",
            "group_base_dn": "dc=mars,dc=eaaplanets,dc=com",
            "directory_status": 5,
            "port": 389,
            "group_token": "primaryGroupToken",
            "ou_attr": "",
            "sync_interval": 21600,
            "user_count": 7,
            "service": 1,
            "resource_uri": {
                "href": "/api/v1/directories/YbVLHLYzSSuruRIhkuWcGw",
                "users": "/api/v1/directories/YbVLHLYzSSuruRIhkuWcGw/users/",
                "groups": "/api/v1/directories/YbVLHLYzSSuruRIhkuWcGw/groups/"
            },
            "signed_request": false,
            "sync_state": 1,
            "root_dn": "mars.eaaplanets.com",
            "auth_response_encrypt": false,
            "company_id": "",
            "logout_url": "",
            "user_memberof": "memberOf",
            "nameidformat": "",
            "uuid_url": "YbVLHLYzSSuruRIhkuWcGw",
            "api_key": "",
            "user_fname": "givenName",
            "conf_state": 1,
            "metadata": "",
            "auth_request_signed": false,
            "admin_user": "mars\\administrator",
            "user_samaccountname": "sAMAccountName",
            "description": "",
            "password_policy_default": "",
            "group_members": "member",
            "user_upn": "userPrincipalName",
            "dialin_sni": "anag-ybvlhlyzssururihkuwcgw.login.dialin.stage.akamai-access.com",
            "ssl": false,
            "group_count": 1,
            "global_catalog": false,
            "password_expire_warn_threshold": 0,
            "kerb_realms": [],
            "ou_object_classes": [
                "organizationalUnit"
            ],
            "user_memberuid": "memberUid",
            "user_lname": "sn",
            "chase_referral": false,
            "schema_attributes": "{}",
            "password_complexity_message": "",
            "password_change_threshold": 0,
            "resource": "directories",
            "name": "mars.eaaplanets.com",
            "user_phone_num": "telephoneNumber",
            "user_base_dn": "dc=mars,dc=eaaplanets,dc=com",
            "created_at": "2018-11-30T05:33:08.344469",
            "server_cert_validate": true,
            "modified_at": "2019-07-22T09:14:41.240310",
            "host": "10.23.1.103",
            "attribute_map": {
                "user.phoneNumber": "telephoneNumber",
                "user.countryCode": "countryCode",
                "user.firstName": "givenName",
                "user.email": "mail",
                "user.lastName": "sn",
                "user.groups": "memberOf",
                "user.netbios": "msDS-PrincipalName",
                "user.persistentId": "objectGUID",
                "user.samAccountName": "sAMAccountName",
                "user.userPrincipleName": "userPrincipalName"
            },
            "last_sync": "2019-07-22T09:14:41.239896",
            "user_object_classes": [
                "person",
                "organizationalPerson",
                "user",
                "inetOrgPerson"
            ],
            "cname": "anag-ybvlhlyzssururihkuwcgw.login.stage.akamai-access.com",
            "status": 1,
            "domains": [],
            "user_principal": "sAMAccountName",
            "password_filter": {},
            "directory_type": 2,
            "user_email": "mail",
            "password_reset_allow": false
        },
        {
            "mfa": "off",
            "ou_filter": "",
            "user_display_name": "displayName",
            "user_search_filter": "(&(objectClass=user)(objectClass=person))",
            "group_object_classes": [
                "group",
                "groupOfNames"
            ],
            "group_name": "cn",
            "password_change_allow": false,
            "agents": [
                {
                    "name": "Alok_OCSP_Ohio",
                    "uuid_url": "ChQHbBiZT_-mwowz2WvLTA"
                }
            ],
            "group_search_filter": "(objectClass=group)",
            "group_base_dn": "dc=eaatest,dc=daredevils,dc=com",
            "directory_status": 5,
            "port": 389,
            "group_token": "primaryGroupToken",
            "ou_attr": "",
            "sync_interval": 21600,
            "user_count": 33,
            "service": 1,
            "resource_uri": {
                "href": "/api/v1/directories/H0WjLZyWTg-It63HRKox1A",
                "users": "/api/v1/directories/H0WjLZyWTg-It63HRKox1A/users/",
                "groups": "/api/v1/directories/H0WjLZyWTg-It63HRKox1A/groups/"
            },
            "signed_request": false,
            "sync_state": 1,
            "root_dn": "eaatest.daredevils.com",
            "auth_response_encrypt": false,
            "company_id": "",
            "logout_url": "",
            "user_memberof": "memberOf",
            "nameidformat": "",
            "uuid_url": "H0WjLZyWTg-It63HRKox1A",
            "api_key": "",
            "user_fname": "givenName",
            "conf_state": 1,
            "metadata": "",
            "auth_request_signed": false,
            "admin_user": "EAATEST\\Administrator",
            "user_samaccountname": "sAMAccountName",
            "description": "eaatest.daredevils.com AD Directory",
            "password_policy_default": "",
            "group_members": "member",
            "user_upn": "userPrincipalName",
            "dialin_sni": "dir-h0wjlzywtg-it63hrkox1a.login.dialin.stage.akamai-access.com",
            "ssl": false,
            "group_count": 1,
            "global_catalog": false,
            "password_expire_warn_threshold": 0,
            "kerb_realms": [],
            "ou_object_classes": [
                "organizationalUnit"
            ],
            "user_memberuid": "memberUid",
            "user_lname": "sn",
            "chase_referral": false,
            "schema_attributes": "{}",
            "password_complexity_message": "",
            "password_change_threshold": 0,
            "resource": "directories",
            "name": "EAATest_Active_Directory_Alpha",
            "user_phone_num": "telephoneNumber",
            "user_base_dn": "dc=eaatest,dc=daredevils,dc=com",
            "created_at": "2019-02-04T08:44:20.146292",
            "server_cert_validate": true,
            "modified_at": "2019-07-22T06:14:42.017977",
            "host": "172.31.3.107",
            "attribute_map": {
                "user.phoneNumber": "telephoneNumber",
                "user.countryCode": "countryCode",
                "user.firstName": "givenName",
                "user.email": "mail",
                "user.lastName": "sn",
                "user.groups": "memberOf",
                "user.netbios": "msDS-PrincipalName",
                "user.persistentId": "objectGUID",
                "user.samAccountName": "sAMAccountName",
                "user.userPrincipleName": "userPrincipalName"
            },
            "last_sync": "2019-07-22T06:14:42.017811",
            "user_object_classes": [
                "person",
                "organizationalPerson",
                "user",
                "inetOrgPerson"
            ],
            "cname": "dir-h0wjlzywtg-it63hrkox1a.login.stage.akamai-access.com",
            "status": 1,
            "domains": [],
            "user_principal": "sAMAccountName",
            "password_filter": {},
            "directory_type": 2,
            "user_email": "mail",
            "password_reset_allow": false
        },
        {
            "mfa": "off",
            "ou_filter": "",
            "user_display_name": "displayName",
            "user_search_filter": "(&(objectClass=user)(objectClass=person))",
            "group_object_classes": [
                "group",
                "groupOfNames"
            ],
            "group_name": "cn",
            "password_change_allow": false,
            "agents": [
                {
                    "name": "Alok-Qa-Wapp-Alpha-Connector-N-California",
                    "uuid_url": "I1QHNAjzQ6KpQiivF5bxGw"
                }
            ],
            "group_search_filter": "(objectClass=group)",
            "group_base_dn": "dc=qadomain,dc=com",
            "directory_status": 6,
            "port": 389,
            "group_token": "primaryGroupToken",
            "ou_attr": "",
            "sync_interval": 21600,
            "user_count": 5,
            "service": 1,
            "resource_uri": {
                "href": "/api/v1/directories/mjR48tfWTaucSaWTwdPQaQ",
                "users": "/api/v1/directories/mjR48tfWTaucSaWTwdPQaQ/users/",
                "groups": "/api/v1/directories/mjR48tfWTaucSaWTwdPQaQ/groups/"
            },
            "signed_request": false,
            "sync_state": 1,
            "root_dn": "qadomain.com",
            "auth_response_encrypt": false,
            "company_id": "",
            "logout_url": "",
            "user_memberof": "memberOf",
            "nameidformat": "",
            "uuid_url": "mjR48tfWTaucSaWTwdPQaQ",
            "api_key": "",
            "user_fname": "givenName",
            "conf_state": 1,
            "metadata": "",
            "auth_request_signed": false,
            "admin_user": "qadomain\\Administrator",
            "user_samaccountname": "sAMAccountName",
            "description": "",
            "password_policy_default": "",
            "group_members": "member",
            "user_upn": "userPrincipalName",
            "dialin_sni": "dir-mjr48tfwtaucsawtwdpqaq.login.dialin.stage.akamai-access.com",
            "ssl": false,
            "group_count": 5,
            "global_catalog": false,
            "password_expire_warn_threshold": 0,
            "kerb_realms": [],
            "ou_object_classes": [
                "organizationalUnit"
            ],
            "user_memberuid": "memberUid",
            "user_lname": "sn",
            "chase_referral": false,
            "schema_attributes": "{}",
            "password_complexity_message": "",
            "password_change_threshold": 0,
            "resource": "directories",
            "name": "ntlm-AD",
            "user_phone_num": "telephoneNumber",
            "user_base_dn": "dc=qadomain,dc=com",
            "created_at": "2019-02-07T15:12:47.988777",
            "server_cert_validate": true,
            "modified_at": "2019-07-22T09:29:54.260934",
            "host": "10.23.1.214",
            "attribute_map": {
                "user.phoneNumber": "telephoneNumber",
                "user.countryCode": "countryCode",
                "user.firstName": "givenName",
                "user.email": "mail",
                "user.lastName": "sn",
                "user.groups": "memberOf",
                "user.netbios": "msDS-PrincipalName",
                "user.persistentId": "objectGUID",
                "user.samAccountName": "sAMAccountName",
                "user.userPrincipleName": "userPrincipalName"
            },
            "last_sync": "2019-07-22T09:29:54.260672",
            "user_object_classes": [
                "person",
                "organizationalPerson",
                "user",
                "inetOrgPerson"
            ],
            "cname": "dir-mjr48tfwtaucsawtwdpqaq.login.stage.akamai-access.com",
            "status": 1,
            "domains": [],
            "user_principal": "sAMAccountName",
            "password_filter": {},
            "directory_type": 2,
            "user_email": "mail",
            "password_reset_allow": false
        },
        {
            "mfa": "off",
            "ou_filter": null,
            "user_display_name": "displayName",
            "user_search_filter": "(&(objectClass=user)(objectClass=person))",
            "group_object_classes": [
                "group",
                "groupOfNames"
            ],
            "group_name": "cn",
            "password_change_allow": false,
            "agents": [],
            "group_search_filter": "(objectClass=group)",
            "group_base_dn": null,
            "directory_status": 3,
            "port": 636,
            "group_token": "primaryGroupToken",
            "ou_attr": null,
            "sync_interval": 21600,
            "user_count": 0,
            "service": 1,
            "resource_uri": {
                "href": "/api/v1/directories/3zxFV_tKRpKnTO5XNDnrhQ",
                "users": "/api/v1/directories/3zxFV_tKRpKnTO5XNDnrhQ/users/",
                "groups": "/api/v1/directories/3zxFV_tKRpKnTO5XNDnrhQ/groups/"
            },
            "signed_request": false,
            "sync_state": 1,
            "root_dn": null,
            "auth_response_encrypt": false,
            "company_id": null,
            "logout_url": "",
            "user_memberof": "memberOf",
            "nameidformat": null,
            "uuid_url": "3zxFV_tKRpKnTO5XNDnrhQ",
            "api_key": null,
            "user_fname": "givenName",
            "conf_state": 1,
            "metadata": "",
            "auth_request_signed": false,
            "admin_user": null,
            "user_samaccountname": "sAMAccountName",
            "description": "test 2",
            "password_policy_default": "",
            "group_members": "member",
            "user_upn": "userPrincipalName",
            "dialin_sni": "dir-3zxfv_tkrpknto5xndnrhq.login.dialin.stage.akamai-access.com",
            "ssl": true,
            "group_count": 0,
            "global_catalog": false,
            "password_expire_warn_threshold": 0,
            "kerb_realms": [],
            "ou_object_classes": [
                "organizationalUnit"
            ],
            "user_memberuid": "memberUid",
            "user_lname": "sn",
            "chase_referral": false,
            "schema_attributes": "{}",
            "password_complexity_message": "",
            "password_change_threshold": 0,
            "resource": "directories",
            "name": "abhitest2",
            "user_phone_num": "telephoneNumber",
            "user_base_dn": null,
            "created_at": "2019-07-22T10:08:32.390504",
            "server_cert_validate": true,
            "modified_at": "2019-07-22T10:08:32.825745",
            "host": null,
            "attribute_map": {
                "user.phoneNumber": "telephoneNumber",
                "user.countryCode": "countryCode",
                "user.firstName": "givenName",
                "user.email": "mail",
                "user.lastName": "sn",
                "user.groups": "memberOf",
                "user.netbios": "msDS-PrincipalName",
                "user.persistentId": "objectGUID",
                "user.samAccountName": "sAMAccountName",
                "user.userPrincipleName": "userPrincipalName"
            },
            "last_sync": "2019-07-22T10:08:32.390625",
            "user_object_classes": [
                "person",
                "organizationalPerson",
                "user",
                "inetOrgPerson"
            ],
            "cname": "dir-3zxfv_tkrpknto5xndnrhq.login.stage.akamai-access.com",
            "status": 1,
            "domains": [],
            "user_principal": "sAMAccountName",
            "password_filter": {},
            "directory_type": 2,
            "user_email": "mail",
            "password_reset_allow": false
        }
    ]
}

  1. Optionally, set the offset query parameter.

  2. Optionally set the limit query parameter.

  3. Optionally set the expand query parameter.

  4. Make a GET request to /crux/v1/mgmt-pop/directories{?offset,limit,expand}.

  5. The operation responds with a list of Directory objects.

Create a directory

Creates a new directory.

POST /crux/v1/mgmt-pop/directories{?contractId}

Sample: /crux/v1/mgmt-pop/directories?contractId=F-EMGSGV

Content-Type: application/json

Object type: Directory

Download schema: directories.json

Request body:

{
    "service": 1,
    "name": "abhitest2",
    "description": "test 2"
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Directory

Download schema: directory.json

Response body:

{
    "admin_user": null,
    "agents": [],
    "api_key": null,
    "attribute_map": {
        "user.countryCode": "countryCode",
        "user.email": "mail",
        "user.firstName": "givenName",
        "user.groups": "memberOf",
        "user.lastName": "sn",
        "user.netbios": "msDS-PrincipalName",
        "user.persistentId": "objectGUID",
        "user.phoneNumber": "telephoneNumber",
        "user.samAccountName": "sAMAccountName",
        "user.userPrincipleName": "userPrincipalName"
    },
    "auth_request_signed": false,
    "auth_response_encrypt": false,
    "chase_referral": false,
    "cname": "dir-3zxfv_tkrpknto5xndnrhq.login.stage.akamai-access.com",
    "company_id": null,
    "conf_state": 1,
    "created_at": "2019-07-22T10:08:32.390504",
    "description": "test 2",
    "dialin_sni": "dir-3zxfv_tkrpknto5xndnrhq.login.dialin.stage.akamai-access.com",
    "directory_status": 3,
    "directory_type": 2,
    "domains": [],
    "global_catalog": false,
    "group_base_dn": null,
    "group_count": 0,
    "group_members": "member",
    "group_name": "cn",
    "group_object_classes": [
        "group",
        "groupOfNames"
    ],
    "group_search_filter": "(objectClass=group)",
    "group_token": "primaryGroupToken",
    "host": null,
    "kerb_realms": [],
    "last_sync": "2019-07-22T10:08:32.390625",
    "logout_url": "",
    "metadata": "",
    "mfa": "off",
    "modified_at": "2019-07-22T10:08:32.825745",
    "name": "abhitest2",
    "nameidformat": null,
    "ou_attr": null,
    "ou_filter": null,
    "ou_object_classes": [
        "organizationalUnit"
    ],
    "password_change_allow": false,
    "password_change_threshold": 0,
    "password_complexity_message": "",
    "password_expire_warn_threshold": 0,
    "password_filter": {},
    "password_policy_default": "",
    "password_reset_allow": false,
    "port": 636,
    "resource": "directories",
    "resource_uri": {
        "groups": "/api/v1/directories/3zxFV_tKRpKnTO5XNDnrhQ/groups/",
        "href": "/api/v1/directories/3zxFV_tKRpKnTO5XNDnrhQ",
        "users": "/api/v1/directories/3zxFV_tKRpKnTO5XNDnrhQ/users/"
    },
    "root_dn": null,
    "schema_attributes": "{}",
    "server_cert_validate": true,
    "service": 1,
    "signed_request": false,
    "ssl": true,
    "status": 1,
    "sync_interval": 21600,
    "sync_state": 1,
    "user_base_dn": null,
    "user_count": 0,
    "user_display_name": "displayName",
    "user_email": "mail",
    "user_fname": "givenName",
    "user_lname": "sn",
    "user_memberof": "memberOf",
    "user_memberuid": "memberUid",
    "user_object_classes": [
        "person",
        "organizationalPerson",
        "user",
        "inetOrgPerson"
    ],
    "user_phone_num": "telephoneNumber",
    "user_principal": "sAMAccountName",
    "user_samaccountname": "sAMAccountName",
    "user_search_filter": "(&(objectClass=user)(objectClass=person))",
    "user_upn": "userPrincipalName",
    "uuid_url": "3zxFV_tKRpKnTO5XNDnrhQ"
}

  1. Build a new Directory object.

  2. POST the object to /crux/v1/mgmt-pop/directories.

  3. The operation responds with a Directory object.

Get a directory

Gets a single directory.

GET /crux/v1/mgmt-pop/directories/{directory_id}{?contractId}

Sample: /crux/v1/mgmt-pop/directories/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
directory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Directory

Download schema: directory.json

Response body:

{
    "mfa": "off",
    "ou_filter": "",
    "user_display_name": "displayName",
    "user_search_filter": "(&(objectClass=user)(objectClass=person))",
    "group_object_classes": [
        "group",
        "groupOfNames"
    ],
    "group_name": "cn",
    "password_change_allow": true,
    "agents": [
        {
            "name": "Alok-Qa-Wapp-Alpha-Connector-N-California",
            "uuid_url": "I1QHNAjzQ6KpQiivF5bxGw"
        },
        {
            "name": "Alok_OCSP_Ohio",
            "uuid_url": "ChQHbBiZT_-mwowz2WvLTA"
        }
    ],
    "group_search_filter": "(objectClass=group)",
    "group_base_dn": "dc=eaatest,dc=daredevils,dc=com",
    "directory_status": 5,
    "port": 636,
    "group_token": "primaryGroupToken",
    "ou_attr": "",
    "sync_interval": 21600,
    "user_count": 204,
    "service": 1,
    "resource_uri": {
        "href": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw",
        "users": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/users/",
        "groups": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/groups/"
    },
    "signed_request": false,
    "sync_state": 1,
    "root_dn": "eaatest.daredevils.com",
    "auth_response_encrypt": false,
    "company_id": "",
    "logout_url": "",
    "user_memberof": "memberOf",
    "nameidformat": "",
    "uuid_url": "aAgAKK45R6-uLK5U8o2iKw",
    "api_key": "",
    "user_fname": "givenName",
    "conf_state": 1,
    "metadata": "",
    "auth_request_signed": false,
    "admin_user": "EAATEST\\administrator",
    "user_samaccountname": "sAMAccountName",
    "description": "",
    "password_policy_default": "dc=eaatest,dc=daredevils,dc=com",
    "group_members": "member",
    "user_upn": "userPrincipalName",
    "dialin_sni": "dir-aagakk45r6-ulk5u8o2ikw.login.dialin.stage.akamai-access.com",
    "ssl": true,
    "group_count": 5,
    "global_catalog": false,
    "password_expire_warn_threshold": 0,
    "kerb_realms": [],
    "ou_object_classes": [
        "organizationalUnit"
    ],
    "user_memberuid": "memberUid",
    "user_lname": "sn",
    "chase_referral": false,
    "schema_attributes": "{}",
    "password_complexity_message": "",
    "password_change_threshold": 0,
    "resource": "directories",
    "name": "EAATEST Directory",
    "user_phone_num": "telephoneNumber",
    "user_base_dn": "dc=eaatest,dc=daredevils,dc=com",
    "created_at": "2017-10-30T06:57:39.221798",
    "server_cert_validate": true,
    "modified_at": "2019-07-22T07:14:56.285600",
    "host": "172.31.3.107",
    "attribute_map": {
        "user.phoneNumber": "telephoneNumber",
        "eaa.demo": "departmentNumber",
        "user.firstName": "givenName",
        "user.userName": "sAMAccountName",
        "user.email": "email",
        "user.lastName": "sn",
        "user.groups": "memberOf",
        "eaa.test": "description",
        "user.netbios": "msDS-PrincipalName",
        "user.persistentId": "objectGUID",
        "user.samAccountName": "sAMAccountName",
        "user.countryCode": "countryCode",
        "user.userPrincipleName": "userPrincipalName"
    },
    "last_sync": "2019-07-22T07:14:56.285286",
    "user_object_classes": [
        "person",
        "organizationalPerson",
        "user",
        "inetOrgPerson"
    ],
    "cname": "dir-aagakk45r6-ulk5u8o2ikw.login.stage.akamai-access.com",
    "status": 1,
    "domains": [],
    "user_principal": "userPrincipalName",
    "password_filter": {},
    "directory_type": 2,
    "user_email": "mail",
    "password_reset_allow": true
}

  1. Run the List directories operation and store the relevant id.

  2. Make a GET request to /crux/v1/mgmt-pop/directories/{id}.

  3. The operation responds with a Directory object.

Modify a directory

Updates an existing directory.

PUT /crux/v1/mgmt-pop/directories/{directory_id}{?contractId}

Sample: /crux/v1/mgmt-pop/directories/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Content-Type: application/json

Object type: Directory

Download schema: directories.json

Request body:

{
    "mfa": "off",
    "ou_filter": "",
    "user_display_name": "displayName",
    "user_search_filter": "(&(objectClass=user)(objectClass=person))",
    "group_object_classes": [
        "group",
        "groupOfNames"
    ],
    "group_name": "cn",
    "password_change_allow": true,
    "agents": [
        {
            "name": "anag-1804-aws-agent",
            "uuid_url": "ikbBcyKGSfmFbRaL8zrslA"
        }
    ],
    "group_search_filter": "(objectClass=group)",
    "group_base_dn": "dc=eaatest,dc=daredevils,dc=com",
    "directory_status": 5,
    "port": 636,
    "group_token": "primaryGroupToken",
    "ou_attr": "",
    "sync_interval": 1209600,
    "user_count": 37,
    "service": 1,
    "signed_request": false,
    "sync_state": 1,
    "root_dn": "eaatest.daredevils.com",
    "auth_response_encrypt": false,
    "company_id": "",
    "logout_url": "",
    "user_memberof": "memberOf",
    "nameidformat": "",
    "api_key": "",
    "user_fname": "givenName",
    "conf_state": 1,
    "metadata": "",
    "auth_request_signed": false,
    "admin_user": "EAATEST\\Administrator",
    "user_samaccountname": "sAMAccountName",
    "description": "aadd",
    "password_policy_default": "dc=eaatest,dc=daredevils,dc=com",
    "group_members": "member",
    "user_upn": "userPrincipalName",
    "dialin_sni": "dir-1xnqzptvrtwczkmwlgcxwq.login.dialin.stage.akamai-access.com",
    "ssl": true,
    "group_count": 4,
    "global_catalog": false,
    "password_expire_warn_threshold": 3600,
    "kerb_realms": [],
    "ou_object_classes": [
        "organizationalUnit"
    ],
    "user_memberuid": "memberUid",
    "user_lname": "sn",
    "chase_referral": false,
    "schema_attributes": "{}",
    "password_complexity_message": "Password must contain at least eight characters and one number.Hello",
    "password_change_threshold": 3600,
    "resource": "directories",
    "name": "EaaTest Directory Alpha",
    "user_phone_num": "telephoneNumber",
    "user_base_dn": "dc=eaatest,dc=daredevils,dc=com",
    "created_at": "2018-10-04T10:57:18.016370",
    "server_cert_validate": true,
    "host": "52.14.222.206",
    "attribute_map": {
        "user.phoneNumber": "telephoneNumber",
        "user.countryCode": "countryCode",
        "user.firstName": "givenName",
        "user.email": "mail",
        "user.lastName": "sn",
        "user.groups": "memberOf",
        "user.netbios": "msDS-PrincipalName",
        "user.persistentId": "objectGUID",
        "user.samAccountName": "sAMAccountName",
        "user.userPrincipleName": "userPrincipalName"
    },
    "last_sync": "2019-07-19T11:59:37.624427",
    "user_object_classes": [
        "person",
        "organizationalPerson",
        "user",
        "inetOrgPerson"
    ],
    "cname": "dir-1xnqzptvrtwczkmwlgcxwq.login.stage.akamai-access.com",
    "status": 1,
    "domains": [
        {
            "name": ""
        }
    ],
    "user_principal": "userPrincipalName",
    "password_filter": {},
    "directory_type": 2,
    "user_email": "mail",
    "password_reset_allow": true
}
Parameter Type Sample Description
URL path parameters
directory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Directory

Download schema: directory.json

Response body:

{
    "mfa": "off",
    "ou_filter": "",
    "user_display_name": "displayName",
    "user_search_filter": "(&(objectClass=user)(objectClass=person))",
    "group_object_classes": [
        "group",
        "groupOfNames"
    ],
    "group_name": "cn",
    "password_change_allow": true,
    "agents": [
        {
            "name": "Alok-Qa-Wapp-Alpha-Connector-N-California",
            "uuid_url": "I1QHNAjzQ6KpQiivF5bxGw"
        },
        {
            "name": "Alok_OCSP_Ohio",
            "uuid_url": "ChQHbBiZT_-mwowz2WvLTA"
        }
    ],
    "group_search_filter": "(objectClass=group)",
    "group_base_dn": "dc=eaatest,dc=daredevils,dc=com",
    "directory_status": 5,
    "port": 636,
    "group_token": "primaryGroupToken",
    "ou_attr": "",
    "sync_interval": 21600,
    "user_count": 204,
    "service": 1,
    "resource_uri": {
        "href": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw",
        "users": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/users/",
        "groups": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/groups/"
    },
    "signed_request": false,
    "sync_state": 1,
    "root_dn": "eaatest.daredevils.com",
    "auth_response_encrypt": false,
    "company_id": "",
    "logout_url": "",
    "user_memberof": "memberOf",
    "nameidformat": "",
    "uuid_url": "aAgAKK45R6-uLK5U8o2iKw",
    "api_key": "",
    "user_fname": "givenName",
    "conf_state": 1,
    "metadata": "",
    "auth_request_signed": false,
    "admin_user": "EAATEST\\administrator",
    "user_samaccountname": "sAMAccountName",
    "description": "",
    "password_policy_default": "dc=eaatest,dc=daredevils,dc=com",
    "group_members": "member",
    "user_upn": "userPrincipalName",
    "dialin_sni": "dir-aagakk45r6-ulk5u8o2ikw.login.dialin.stage.akamai-access.com",
    "ssl": true,
    "group_count": 5,
    "global_catalog": false,
    "password_expire_warn_threshold": 0,
    "kerb_realms": [],
    "ou_object_classes": [
        "organizationalUnit"
    ],
    "user_memberuid": "memberUid",
    "user_lname": "sn",
    "chase_referral": false,
    "schema_attributes": "{}",
    "password_complexity_message": "",
    "password_change_threshold": 0,
    "resource": "directories",
    "name": "EAATEST Directory",
    "user_phone_num": "telephoneNumber",
    "user_base_dn": "dc=eaatest,dc=daredevils,dc=com",
    "created_at": "2017-10-30T06:57:39.221798",
    "server_cert_validate": true,
    "modified_at": "2019-07-22T07:14:56.285600",
    "host": "172.31.3.107",
    "attribute_map": {
        "user.phoneNumber": "telephoneNumber",
        "eaa.demo": "departmentNumber",
        "user.firstName": "givenName",
        "user.userName": "sAMAccountName",
        "user.email": "email",
        "user.lastName": "sn",
        "user.groups": "memberOf",
        "eaa.test": "description",
        "user.netbios": "msDS-PrincipalName",
        "user.persistentId": "objectGUID",
        "user.samAccountName": "sAMAccountName",
        "user.countryCode": "countryCode",
        "user.userPrincipleName": "userPrincipalName"
    },
    "last_sync": "2019-07-22T07:14:56.285286",
    "user_object_classes": [
        "person",
        "organizationalPerson",
        "user",
        "inetOrgPerson"
    ],
    "cname": "dir-aagakk45r6-ulk5u8o2ikw.login.stage.akamai-access.com",
    "status": 1,
    "domains": [],
    "user_principal": "userPrincipalName",
    "password_filter": {},
    "directory_type": 2,
    "user_email": "mail",
    "password_reset_allow": true
}

  1. Run the List directories operation and store the relevant id.

  2. Run the Get a directory operation and store the response object.

  3. Modify the Directory object.

  4. PUT the object to /crux/v1/mgmt-pop/directories/{id}.

  5. The operation responds with a Directory object.

Delete a directory

Deletes an existing directory.

DELETE /crux/v1/mgmt-pop/directories/{directory_id}{?contractId}

Sample: /crux/v1/mgmt-pop/directories/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
directory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 204

  1. Run the List directories operation and store the relevant id.

  2. Make a DELETE request to /crux/v1/mgmt-pop/directories/{id}.

List directory applications

Gets list of associated applications.

GET /crux/v1/mgmt-pop/directories/{directory_id}/apps{?contractId}

Sample: /crux/v1/mgmt-pop/directories/ojxkXzwyQZiBkoRee0XcnA/apps?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
directory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Application

Download schema: applications.json

Response body:

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 3
    },
    "objects": [
        {
            "app": {
                "app_uuid_url": "rifZbAclREyEF7TPAoKNiw",
                "name": "bala-okta-http"
            },
            "directory": {
                "directory_uuid_url": "aAgAKK45R6-uLK5U8o2iKw",
                "name": "EAATEST Directory"
            },
            "enable_mfa": "inherit",
            "resource": "appdirectories",
            "resource_uri": {
                "apps": "/api/v1/apps/rifZbAclREyEF7TPAoKNiw",
                "directories": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw",
                "href": "/api/v1/appdirectories/-eGoXVYPTbKBEDtHlgtq1w"
            },
            "uuid_url": "-eGoXVYPTbKBEDtHlgtq1w"
        },
        {
            "app": {
                "app_uuid_url": "WRRBMsmbR8GwLJhEQVI6hg",
                "name": "Office 365 SaaS Application"
            },
            "directory": {
                "directory_uuid_url": "aAgAKK45R6-uLK5U8o2iKw",
                "name": "EAATEST Directory"
            },
            "enable_mfa": "inherit",
            "resource": "appdirectories",
            "resource_uri": {
                "apps": "/api/v1/apps/WRRBMsmbR8GwLJhEQVI6hg",
                "directories": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw",
                "href": "/api/v1/appdirectories/SaH1hpCNRvGMvsbnYyNFwQ"
            },
            "uuid_url": "SaH1hpCNRvGMvsbnYyNFwQ"
        },
        {
            "app": {
                "app_uuid_url": "xNf2mfk5QpaL04g_yaoVgA",
                "name": "OCSP Enabled App"
            },
            "directory": {
                "directory_uuid_url": "aAgAKK45R6-uLK5U8o2iKw",
                "name": "EAATEST Directory"
            },
            "enable_mfa": "inherit",
            "resource": "appdirectories",
            "resource_uri": {
                "apps": "/api/v1/apps/xNf2mfk5QpaL04g_yaoVgA",
                "directories": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw",
                "href": "/api/v1/appdirectories/P3kpZuzGSqOU8ojNkXkRPA"
            },
            "uuid_url": "P3kpZuzGSqOU8ojNkXkRPA"
        }
    ]
}

  1. Run the List directories operation and store the relevant id.

  2. Make a GET request to /crux/v1/mgmt-pop/directories/{id}/apps.

  3. The operation responds with a Application object.

List directory groups

Gets a list of associated groups.

GET /crux/v1/mgmt-pop/directories/{directory_id}/groups{?contractId}

Sample: /crux/v1/mgmt-pop/directories/ojxkXzwyQZiBkoRee0XcnA/groups?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
directory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Group

Download schema: groups.json

Response body:

{
    "meta": {
        "previous": null,
        "total_count": 5,
        "offset": 0,
        "limit": 20,
        "next": null
    },
    "objects": [
        {
            "status": 1,
            "user_count": 32,
            "resource": "groups",
            "description": "",
            "created_at": "2017-11-02T12:11:11.210052",
            "modified_at": "2017-11-02T12:11:11.210072",
            "uuid_url": "NMC-zgOjR7GW88Z-GCjZeQ",
            "resource_uri": {
                "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/",
                "href": "/api/v1/groups/NMC-zgOjR7GW88Z-GCjZeQ",
                "users": "/api/v1/groups/NMC-zgOjR7GW88Z-GCjZeQ/users/",
                "permissions": "/api/v1/groups/NMC-zgOjR7GW88Z-GCjZeQ/permissions/"
            },
            "group_type": 2,
            "name": "demoGrp"
        },
        {
            "status": 1,
            "user_count": 1,
            "resource": "groups",
            "description": "",
            "created_at": "2018-06-19T07:53:24.104005",
            "modified_at": "2018-06-19T07:53:24.104024",
            "uuid_url": "0LtQnsKQSAWZoP-OiHl21g",
            "resource_uri": {
                "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/",
                "href": "/api/v1/groups/0LtQnsKQSAWZoP-OiHl21g",
                "users": "/api/v1/groups/0LtQnsKQSAWZoP-OiHl21g/users/",
                "permissions": "/api/v1/groups/0LtQnsKQSAWZoP-OiHl21g/permissions/"
            },
            "group_type": 4,
            "name": "Overlay group"
        }
    ]
}

  1. Run the List directories operation and store the relevant id.

  2. Make a GET request to /crux/v1/mgmt-pop/directories/{id}/groups.

  3. The operation responds with a Group object.

Get group details

Gets the details of a group.

GET /crux/v1/mgmt-pop/directories/{directory_id}/groups/{group_id}{?contractId}

Sample: /crux/v1/mgmt-pop/directories/ojxkXzwyQZiBkoRee0XcnA/groups/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
directory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each directory.
group_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each group.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Response body:

{
    "status": 1,
    "user_count": 175,
    "resource": "groups",
    "description": "",
    "created_at": "2017-10-30T10:12:03.783055",
    "modified_at": "2017-10-30T10:12:03.783080",
    "uuid_url": "lDezLHf5QaeFYJyaWOHqAw",
    "resource_uri": {
        "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/",
        "href": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw",
        "users": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw/users/",
        "permissions": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw/permissions/"
    },
    "group_type": 2,
    "name": "Domain Users"
}

  1. Run the List directories operation and store the relevant id.

  2. Run the List directory groups operation and store the relevant group_id.

  3. Make a GET request to /crux/v1/mgmt-pop/directories/{id}/groups/{group_id}.

  4. The operation responds with a Group object.

List directory group users

Gets a list of users associated with a group.

GET /crux/v1/mgmt-pop/directories/{directory_id}/groups/{group_id}/users{?contractId}

Sample: /crux/v1/mgmt-pop/directories/ojxkXzwyQZiBkoRee0XcnA/groups/ojxkXzwyQZiBkoRee0XcnA/users?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
directory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each directory.
group_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each group.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: User

Download schema: users.json

Response body:

{
    "meta": {
        "limit": 20,
        "next": "?limit=20&offset=20",
        "offset": 0,
        "previous": null,
        "total_count": 175
    },
    "objects": [
        {
            "description": "",
            "group": {
                "group_uuid_url": "lDezLHf5QaeFYJyaWOHqAw",
                "name": "Domain Users"
            },
            "name": "",
            "resource_uri": {
                "groups": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw",
                "href": "/api/v1/groupmembership/7RBSRcmaQqq0YEUClWqL_w",
                "users": "/api/v1/users/Cjy9Gxw2RpaKh8NrMo8_Lw"
            },
            "status": 1,
            "user": {
                "created_at": "2018-06-29T18:11:29.074899",
                "display_name": "",
                "email": "",
                "first_name": "Test SQA",
                "last_name": "User (12)",
                "normalized_attributes": {
                    "eaa.demo": [],
                    "eaa.test": [],
                    "eaa.userName": "sqauser12@eaatest.daredevils.com",
                    "user.countryCode": 0,
                    "user.email": "",
                    "user.firstName": "Test SQA",
                    "user.groups": [],
                    "user.lastName": "User (12)",
                    "user.netbios": "EAATEST",
                    "user.persistentId": "b232a4d4-50ec-4338-a4e0-296aca4c391f",
                    "user.phoneNumber": [],
                    "user.samAccountName": "sqauser12",
                    "user.userName": "sqauser12",
                    "user.userPrincipleName": "sqauser12@eaatest.daredevils.com"
                },
                "user_uuid_url": "Cjy9Gxw2RpaKh8NrMo8_Lw",
                "username": "sqauser12@eaatest.daredevils.com"
            },
            "uuid_url": "7RBSRcmaQqq0YEUClWqL_w"
        }
    ]
}

  1. Run the List directories operation and store the relevant id.

  2. Run the List directory groups operation and store the relevant group_id.

  3. Make a GET request to /crux/v1/mgmt-pop/directories/{id}/groups/{group_id}/users.

  4. The operation responds with a User object.

List directory users

Gets a list of users for a directory.

GET /crux/v1/mgmt-pop/directories/{directory_id}/users{?contractId}

Sample: /crux/v1/mgmt-pop/directories/ojxkXzwyQZiBkoRee0XcnA/users?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
directory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: User

Download schema: users.json

Response body:

{
    "meta": {
        "previous": null,
        "total_count": 204,
        "offset": 0,
        "limit": 20,
        "next": "?limit=20&offset=20"
    },
    "objects": [
        {
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "last_name": "",
            "user_type": 2,
            "country_code": 0,
            "first_name": "newuser12",
            "display_name": "",
            "last_admin_login": null,
            "normalized_attributes": {
                "user.phoneNumber": [],
                "eaa.demo": [],
                "user.groups": [
                    "CN=demogroup,CN=Users,DC=eaatest,DC=daredevils,DC=com"
                ],
                "user.userName": "newuser12",
                "eaa.test": [],
                "user.email": "",
                "user.lastName": [],
                "user.firstName": "newuser12",
                "eaa.userName": "newuser12@eaatest.daredevils.com",
                "user.netbios": "EAATEST",
                "user.persistentId": "21f7150a-499f-4c87-833e-16818146bd5d",
                "user.samAccountName": "newuser12",
                "user.countryCode": 0,
                "user.userPrincipleName": "newuser12@eaatest.daredevils.com"
            },
            "uuid_url": "P0M1yazIRsWaod0sMt2sGg",
            "last_login": null,
            "registered": false,
            "dn": "CN=newuser12,CN=Users,DC=eaatest,DC=daredevils,DC=com",
            "phone_num": "",
            "samaccountname": "newuser12",
            "password_set": false,
            "url_valid": false,
            "attrib_hash": "49a5237caf14789fab7635cd9105aa58",
            "password": null,
            "netbios": "EAATEST",
            "upn": "newuser12@eaatest.daredevils.com",
            "last_accessed_tenant_uuid_url": null,
            "modified_at": "2019-07-02T13:55:20.880278",
            "email": "",
            "username": "newuser12@eaatest.daredevils.com",
            "status": 0,
            "mfa_reset": false,
            "url_timestamp": "2017-10-30T10:12:05.262165",
            "created_at": "2017-10-30T10:12:05.261965",
            "resource_uri": {
                "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw",
                "href": "/api/v1/users/P0M1yazIRsWaod0sMt2sGg",
                "groups": "/api/v1/users/P0M1yazIRsWaod0sMt2sGg/groups/",
                "permissions": "/api/v1/users/P0M1yazIRsWaod0sMt2sGg/permissions/"
            }
        },
        {
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "last_name": "",
            "user_type": 2,
            "country_code": 0,
            "first_name": "newuser10",
            "display_name": "",
            "last_admin_login": null,
            "normalized_attributes": {
                "user.phoneNumber": [],
                "eaa.demo": [],
                "user.groups": [
                    "CN=alokgrp,CN=Users,DC=eaatest,DC=daredevils,DC=com"
                ],
                "user.userName": "newuser10",
                "eaa.test": [],
                "user.email": "",
                "user.lastName": [],
                "user.firstName": "newuser10",
                "eaa.userName": "newuser10@eaatest.daredevils.com",
                "user.netbios": "EAATEST",
                "user.persistentId": "ec34e98c-8caf-45b8-ac61-e1f97221f53b",
                "user.samAccountName": "newuser10",
                "user.countryCode": 0,
                "user.userPrincipleName": "newuser10@eaatest.daredevils.com"
            },
            "uuid_url": "SejVnwliRfSmlpV3oo2IRA",
            "last_login": null,
            "registered": false,
            "dn": "CN=newuser10,CN=Users,DC=eaatest,DC=daredevils,DC=com",
            "phone_num": "",
            "samaccountname": "newuser10",
            "password_set": false,
            "url_valid": false,
            "attrib_hash": "5cb5de559077a277635c233896c9c2d8",
            "password": null,
            "netbios": "EAATEST",
            "upn": "newuser10@eaatest.daredevils.com",
            "last_accessed_tenant_uuid_url": null,
            "modified_at": "2019-07-02T13:55:20.617409",
            "email": "",
            "username": "newuser10@eaatest.daredevils.com",
            "status": 0,
            "mfa_reset": false,
            "url_timestamp": "2017-10-30T10:12:05.262469",
            "created_at": "2017-10-30T10:12:05.262296",
            "resource_uri": {
                "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw",
                "href": "/api/v1/users/SejVnwliRfSmlpV3oo2IRA",
                "groups": "/api/v1/users/SejVnwliRfSmlpV3oo2IRA/groups/",
                "permissions": "/api/v1/users/SejVnwliRfSmlpV3oo2IRA/permissions/"
            }
        }
    ]
}

  1. Run the List directories operation and store the relevant id.

  2. Make a GET request to /crux/v1/mgmt-pop/directories/{id}/users.

  3. The operation responds with a User object.

Invite an user

Invite an user for a cloud directory.

POST /crux/v1/mgmt-pop/directories/{directory_id}/users{?contractId}

Sample: /crux/v1/mgmt-pop/directories/ojxkXzwyQZiBkoRee0XcnA/users?contractId=F-EMGSGV

Content-Type: application/json

Request body:

{
    "email": "example@akamai.com",
    "first_name": "abc",
    "last_name": "xyz"
}
Parameter Type Sample Description
URL path parameters
directory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: User

Download schema: users.json

Response body:

{
    "cmdid": "a047d9cd-e36d-4f81-9abd-1250433238e2"
}

User autocomplete

Returns a list of user email addresses matching the given string.

GET /crux/v1/mgmt-pop/directories/{directory_id}/users/autocomplete{?q,contractId}

Sample: /crux/v1/mgmt-pop/directories/ojxkXzwyQZiBkoRee0XcnA/users/autocomplete?q=abc&contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
directory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each directory.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
q String abc Autocomplete string

Status 200 application/json

Download schema: user-autocomplete.json

Response body:

[
    "abc",
    "abc@eaatest.daredevils.com",
    "acluser1",
    "acluser1@eaatest.daredevils.com",
    "acluser2",
    "acluser2@eaatest.daredevils.com",
    "alok.nag",
    "alok.nag@eaatest.daredevils.com",
    "aloknag@eaatest.daredevils.com"
]

  1. Run the List directories operation and store the relevant directory id.

  2. Set the q query parameter to the target autocomplete string.

  3. Ensure you have your contractId query parameter.

  4. Make a GET request to /crux/v1/mgmt-pop/directories/{id}/users/autocomplete{?q,contractId}.

  5. The operation responds with a list of user IDs.

Get user details

Gets details of a user.

GET /crux/v1/mgmt-pop/directories/{directory_id}/users/byname/{user_id}{?contractId}

Sample: /crux/v1/mgmt-pop/directories/ojxkXzwyQZiBkoRee0XcnA/users/byname/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
directory_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each directory.
user_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each user.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: User

Download schema: user.json

Response body:

{
    "mfa": {
        "admin_mfa": false,
        "login_mfa": true
    },
    "last_name": "",
    "user_type": 2,
    "country_code": 0,
    "first_name": "newuser12",
    "display_name": "",
    "last_admin_login": null,
    "normalized_attributes": {
        "user.phoneNumber": [],
        "eaa.demo": [],
        "user.groups": [
            "CN=demogroup,CN=Users,DC=eaatest,DC=daredevils,DC=com"
        ],
        "user.userName": "newuser12",
        "eaa.test": [],
        "user.email": "",
        "user.lastName": [],
        "user.firstName": "newuser12",
        "eaa.userName": "newuser12@eaatest.daredevils.com",
        "user.netbios": "EAATEST",
        "user.persistentId": "21f7150a-499f-4c87-833e-16818146bd5d",
        "user.samAccountName": "newuser12",
        "user.countryCode": 0,
        "user.userPrincipleName": "newuser12@eaatest.daredevils.com"
    },
    "uuid_url": "P0M1yazIRsWaod0sMt2sGg",
    "last_login": null,
    "registered": false,
    "dn": "CN=newuser12,CN=Users,DC=eaatest,DC=daredevils,DC=com",
    "phone_num": "",
    "samaccountname": "newuser12",
    "password_set": false,
    "url_valid": false,
    "attrib_hash": "49a5237caf14789fab7635cd9105aa58",
    "password": null,
    "netbios": "EAATEST",
    "upn": "newuser12@eaatest.daredevils.com",
    "last_accessed_tenant_uuid_url": null,
    "modified_at": "2019-07-02T13:55:20.880278",
    "email": "",
    "username": "newuser12@eaatest.daredevils.com",
    "status": 0,
    "mfa_reset": false,
    "url_timestamp": "2017-10-30T10:12:05.262165",
    "created_at": "2017-10-30T10:12:05.261965",
    "resource_uri": {
        "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw",
        "href": "/api/v1/users/P0M1yazIRsWaod0sMt2sGg",
        "groups": "/api/v1/users/P0M1yazIRsWaod0sMt2sGg/groups/",
        "permissions": "/api/v1/users/P0M1yazIRsWaod0sMt2sGg/permissions/"
    }
}

  1. Run the List directories operation and store the relevant id.

  2. Run the List directory users operation and store the relevant user_id.

  3. Ensure you have your contractId query parameter.

  4. Make a GET request to /crux/v1/mgmt-pop/directories/{id}/users/byname/{user_id}{?contractId}.

  5. The operation responds with a User object.

Bulk create user

Creates users in bulk for a cloud directory using a CSV.

POST /crux/v1/mgmt-pop/directories/createusers{?contractId}

Sample: /crux/v1/mgmt-pop/directories/createusers?contractId=F-EMGSGV

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Form parameters
users File email, firstname, lastname, password, groups CSV file containing user details.

Status 200 application/json

Object type: CommandId

Download schema: cmdid.json

Response body:

{
    "cmdid": "28801ce8-aa3a-4cd9-a48d-4680f6f8fc47"
}

  1. Ensure you have your contractId query parameter.

  2. Build or store a CSV file containing the bulk user data.

  3. Prepare a multipart/form-data request, specifying the users form parameter. For example, Content-Disposition: form-data;.

  4. Make a form data POST request to /crux/v1/mgmt-pop/directories/createusers{?contractId}.

  5. The operation responds with a CommandId object.

User upload status

Gets a user’s upload status.

GET /crux/v1/mgmt-pop/directories/createusers/status/{cmd_id}{?contractId}

Sample: /crux/v1/mgmt-pop/directories/createusers/status/ce8b4684-a504-4288-b80d–98f0bce20545?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
cmd_id String ce8b4684-a504-4288-b80d-98f0bce20545 A unique identifier for the create a user operation.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Status

Download schema: status.json

Response body:

{
    "status": "complete",
    "success": 2,
    "failed": 0,
    "failed_details": [],
    "result": "https://s3.amazonaws.com/user-actions/user-bulk-action-1562916653.json",
    "total": 2
}

  1. Store the cmd_id parameter from the User upload status operation response.

  2. Ensure you have your contractId query parameter.

  3. Make a GET request to /crux/v1/mgmt-pop/directories/createusers/status/{cmd_id}{?contractId}.

  4. The operation responds with a Status object.

Bulk delete user

Deletes users in bulk for a cloud directory.

POST /crux/v1/mgmt-pop/directories/deleteusers{?contractId}

Sample: /crux/v1/mgmt-pop/directories/deleteusers?contractId=F-EMGSGV

Content-Type: application/json

Request body:

{
    "user_list": [
        "43pATzNCTrWMbieFfGQiGw",
        "-PMZRhFxSf-rteD60F7Z_A"
    ]
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Status

Download schema: status.json

Response body:

{
    "status": "complete",
    "failed": 0,
    "failed_details": [],
    "total": 2,
    "success": 2
}

  1. Ensure you have your contractId query parameter.

  2. Build an object containing a user_list array containing a list of target user ID strings.

  3. POST the object to /crux/v1/mgmt-pop/directories/deleteusers{?contractId}.

  4. The operation responds with a Status object.

Re-invite user

Re-invite users for a cloud directory.

POST /crux/v1/mgmt-pop/directories/reinviteusers{?contractId}

Sample: /crux/v1/mgmt-pop/directories/reinviteusers?contractId=F-EMGSGV

Content-Type: application/json

Request body:

{
    "user_list": [
        "a5hPUIBTTI2vkbXxDWfjaQ"
    ]
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: CommandId

Download schema: cmdid.json

Response body:

{
    "cmdid": "a047d9cd-e36d-4f81-9abd-1250433238e2"
}

  1. Ensure you have your contractId query parameter.

  2. Build an object containing a user_list array containing a list of target user ID strings.

  3. POST the object to /crux/v1/mgmt-pop/directories/reinviteusers{?contractId}.

  4. The operation responds with a CommandId object.

Verify re-invite status

Gets the re-invite status for a user.

GET /crux/v1/mgmt-pop/directories/reinviteusers/status/{cmd_id}{?contractId}

Sample: /crux/v1/mgmt-pop/directories/reinviteusers/status/ce8b4684-a504-4288-b80d–98f0bce20545?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
cmd_id String ce8b4684-a504-4288-b80d-98f0bce20545 A unique identifier for the verify re-invite status operation.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Status

Download schema: status.json

Response body:

{
    "status": "complete",
    "success": 2,
    "failed": 0,
    "failed_details": [],
    "result": "https://s3.amazonaws.com/user-actions/user-bulk-action-1562916653.json",
    "total": 2
}

  1. Store the cmd_id parameter from the Re-invite user operation response.

  2. Ensure you have your contractId query parameter.

  3. Make a GET request to /crux/v1/mgmt-pop/directories/reinviteusers/status/{cmd_id}{?contractId}.

  4. The operation responds with a Status object.

Verify directory

Verifies that connectors can reach and connect to the directory.

POST /crux/v1/mgmt-pop/directories/verify{?contractId}

Sample: /crux/v1/mgmt-pop/directories/verify?contractId=F-EMGSGV

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: CommandId

Download schema: cmdid.json

Response body:

{
    "status": "pending",
    "cmdid": "1f8675b0-9b8f-4816-813b-128b1b92ad4b",
    "dir_status": 5
}

  1. Ensure you have your contractId query parameter.

  2. Make a POST request to /crux/v1/mgmt-pop/directories/verify{?contractId}.

  3. The operation responds with a CommandId object.

Check verify status

Checks the status of an ongoing verify operation.

GET /crux/v1/mgmt-pop/directories/verify/{cmd_id}{?contractId}

Sample: /crux/v1/mgmt-pop/directories/verify/ce8b4684-a504-4288-b80d–98f0bce20545?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
cmd_id String ce8b4684-a504-4288-b80d-98f0bce20545 A unique identifier issued for a verify directory user operation.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Status

Download schema: status.json

Response body:

{
    "status": "complete",
    "dir_reach_error": "",
    "cmdid": "1f8675b0-9b8f-4816-813b-128b1b92ad4b",
    "dir_status": 7
}

  1. Store the cmd_id parameter from the Verify directory operation response.

  2. Ensure you have your contractId query parameter.

  3. Make a GET request to /crux/v1/mgmt-pop/directories/verify/{cmd_id}{?contractId}.

  4. The operation responds with a Status object.

Search directory

Searches a directory for the specified query string.

POST /crux/v1/mgmt-pop/directories/search{?contractId}

Sample: /crux/v1/mgmt-pop/directories/search?contractId=F-EMGSGV

Content-Type: application/json

Request body:

{
    "user": "aa"
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: CommandId

Download schema: cmdid.json

Response body:

{
    "status": "PENDING",
    "cmdid": "1c4e70dc-ff5e-4268-b87c-4f44d800a778"
}

  1. Ensure you have your contractId query parameter.

  2. Build an object containing the parameter and value you want to query.

  3. POST the object to /crux/v1/mgmt-pop/directories/search{?contractId}.

  4. The operation responds with a CommandId object.

Sync directory

Synchronizes the external directory with EAA. Directories synchronize automatically every 6 hours.

POST /crux/v1/mgmt-pop/directories/sync{?contractId}

Sample: /crux/v1/mgmt-pop/directories/sync?contractId=F-EMGSGV

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Response body:

{
    "message": "Syncing directories"
}

  1. Make a POST request to /crux/v1/mgmt-pop/directories/sync.

  2. The operation responds with a single-member object containing a confirmation message.

List group memberships

Gets a list of group memberships.

GET /crux/v1/mgmt-pop/groupmembership{?contractId,offset,limit,expand}

Sample: /crux/v1/mgmt-pop/groupmembership?contractId=F-EMGSGV&offset=10&limit=30&expand=true

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: GroupMembership

Download schema: groupmembership.json

Response body:

{
    "meta": {
        "limit": 2,
        "next": "?expand=true&limit=2&offset=4",
        "offset": 2,
        "previous": "?expand=true&limit=2&offset=0",
        "total_count": 114764
    },
    "objects": [
        {
            "description": null,
            "group": {
                "group_uuid_url": "GYbYGhfjQKqSzWIMK5VHcw",
                "name": "1k_users_group"
            },
            "name": null,
            "resource_uri": {
                "groups": "/api/v1/groups/GYbYGhfjQKqSzWIMK5VHcw",
                "href": "/api/v1/groupmembership/xdJdjiWLRb26jSUkI0-qPQ",
                "users": "/api/v1/users/k8bFfDTiQluq4nX7GOdgsg"
            },
            "status": 1,
            "user": {
                "created_at": "2020-03-18T05:36:58.666741",
                "display_name": "",
                "email": "2m_test_user_441@eaatest.daredevils.com",
                "first_name": "test_441",
                "last_name": "",
                "normalized_attributes": {
                    "custom.employeeType": "",
                    "custom.test1attribute": "",
                    "custom.test2attribute": "",
                    "custom.test3attribute": "",
                    "custom.test4attribute": "",
                    "custom.test5attribute": "",
                    "custom.test6attribute": "2m_test_user_441@eaatest.daredevils.com",
                    "eaa.userName": "2m_test_user_441",
                    "user.countryCode": 0,
                    "user.email": "2m_test_user_441@eaatest.daredevils.com",
                    "user.firstName": "test_441",
                    "user.groups": [
                        "CN=1.5m_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=1.3m_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=2m_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=30k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=50k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=10k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=1k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=800k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=1m_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=500k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=300k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=100k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com"
                    ],
                    "user.lastName": "",
                    "user.netbios": "EAATEST",
                    "user.persistentId": "cddc0d21-fdc9-4f62-a5d6-52285859f0a3",
                    "user.phoneNumber": [],
                    "user.samAccountName": "2m_test_user_441",
                    "user.userPrincipleName": "2m_test_user_441@eaatest.daredevils.com"
                },
                "user_uuid_url": "k8bFfDTiQluq4nX7GOdgsg",
                "username": "2m_test_user_441"
            },
            "uuid_url": "xdJdjiWLRb26jSUkI0-qPQ"
        },
        {
            "description": null,
            "group": {
                "group_uuid_url": "GYbYGhfjQKqSzWIMK5VHcw",
                "name": "1k_users_group"
            },
            "name": null,
            "resource_uri": {
                "groups": "/api/v1/groups/GYbYGhfjQKqSzWIMK5VHcw",
                "href": "/api/v1/groupmembership/gn-9VpqlSNqK9sTqoK1LfQ",
                "users": "/api/v1/users/DPptf5lxSvOtZ0t1jwOQ3A"
            },
            "status": 1,
            "user": {
                "created_at": "2020-03-18T05:36:58.666925",
                "display_name": "",
                "email": "2m_test_user_62@eaatest.daredevils.com",
                "first_name": "test_62",
                "last_name": "",
                "normalized_attributes": {
                    "custom.employeeType": "",
                    "custom.test1attribute": "",
                    "custom.test2attribute": "",
                    "custom.test3attribute": "",
                    "custom.test4attribute": "",
                    "custom.test5attribute": "",
                    "custom.test6attribute": "2m_test_user_62@eaatest.daredevils.com",
                    "eaa.userName": "2m_test_user_62",
                    "user.countryCode": 0,
                    "user.email": "2m_test_user_62@eaatest.daredevils.com",
                    "user.firstName": "test_62",
                    "user.groups": [
                        "CN=100_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=1.5m_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=1.3m_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=2m_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=30k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=50k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=10k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=1k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=800k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=1m_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=500k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=300k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com",
                        "CN=100k_users_group,CN=Users,DC=eaatest,DC=daredevils,DC=com"
                    ],
                    "user.lastName": "",
                    "user.netbios": "EAATEST",
                    "user.persistentId": "927f4527-40de-4798-9772-1762ef4f6a59",
                    "user.phoneNumber": [],
                    "user.samAccountName": "2m_test_user_62",
                    "user.userPrincipleName": "2m_test_user_62@eaatest.daredevils.com"
                },
                "user_uuid_url": "DPptf5lxSvOtZ0t1jwOQ3A",
                "username": "2m_test_user_62"
            },
            "uuid_url": "gn-9VpqlSNqK9sTqoK1LfQ"
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/mgmt-pop/groupmembership{?contractId}.

  3. The operation responds with a GroupMembership object.

Create a group membership

Creates a new group membership.

POST /crux/v1/mgmt-pop/groupmembership{?contractId}

Sample: /crux/v1/mgmt-pop/groupmembership?contractId=F-EMGSGV

Content-Type: application/json

Object type: GroupMembership

Download schema: groupmembership.json

Request body:

{
    "groups": [
        "cmsvv_YkTY2rcoeOS5cIzg"
    ],
    "accounts": [
        "eY9q-j8GTCWiWzupFKLYrA"
    ]
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: GroupMembership

Download schema: groupmembership.json

Response body:

[
    {
        "description": null,
        "group": "cmsvv_YkTY2rcoeOS5cIzg",
        "name": null,
        "resource_uri": {
            "groups": "/api/v1/groups/cmsvv_YkTY2rcoeOS5cIzg",
            "href": "/api/v1/groupmembership/8UYkyhenThS0ot_9fH3DgQ",
            "users": "/api/v1/users/eY9q-j8GTCWiWzupFKLYrA"
        },
        "status": 1,
        "user": "eY9q-j8GTCWiWzupFKLYrA",
        "user_email": "cmsvv_YkTY2rcoeOS5cIzg",
        "uuid_url": "8UYkyhenThS0ot_9fH3DgQ"
    }
]

  1. Ensure you have your contractId query parameter.

  2. Build a new GroupMembership object.

  3. POST the object to /crux/v1/mgmt-pop/groupmembership{?contractId}.

  4. The operation responds with a GroupMembership object.

Get a group membership

Gets a single group membership.

GET /crux/v1/mgmt-pop/groupmembership/{groupmembership_id}{?contractId}

Sample: /crux/v1/mgmt-pop/groupmembership/83A4xHlyS9eQkjxEM1qsVw?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
groupmembership_id String 83A4xHlyS9eQkjxEM1qsVw A unique identifier of each group membership.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: GroupMembership

Download schema: groupmembership.json

Response body:

{
    "description": null,
    "name": null,
    "resource_uri": {
        "groups": "/api/v1/groups/GYbYGhfjQKqSzWIMK5VHcw",
        "href": "/api/v1/groupmembership/xdJdjiWLRb26jSUkI0-qPQ",
        "users": "/api/v1/users/k8bFfDTiQluq4nX7GOdgsg"
    },
    "status": 1,
    "uuid_url": "xdJdjiWLRb26jSUkI0-qPQ"
}

  1. Run the List group memberships operation and store the relevant id.

  2. Make a GET request to /crux/v1/mgmt-pop/groupmembership/{id}.

  3. The operation responds with a GroupMembership object.

Delete a group membership

Deletes an existing group membership.

DELETE /crux/v1/mgmt-pop/groupmembership/{groupmembership_id}{?contractId}

Sample: /crux/v1/mgmt-pop/groupmembership/83A4xHlyS9eQkjxEM1qsVw?contractId=F-EMGSGV

Content-Type: application/json

Object type: GroupMembership

Download schema: groupmembership.json

Request body:

{
    "deleted_objects": [
        "8UYkyhenThS0ot_9fH3DgQ"
    ]
}
Parameter Type Sample Description
URL path parameters
groupmembership_id String 83A4xHlyS9eQkjxEM1qsVw A unique identifier of each group membership.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: GroupMembership

Download schema: groupmembership.json

Response body:

{
    "message": "Successful"
}

  1. Run the List group memberships operation and store the relevant id.

  2. Make a DELETE request to /crux/v1/mgmt-pop/groupmembership/{id}.

List Groups

Gets a list of groups.

GET /crux/v1/mgmt-pop/groups{?contractId,offset,limit}

Sample: /crux/v1/mgmt-pop/groups?contractId=F-EMGSGV&offset=10&limit=30

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: Group

Download schema: groups.json

Response body:

{
    "meta": {
        "previous": null,
        "total_count": 5,
        "offset": 0,
        "limit": 20,
        "next": null
    },
    "objects": [
        {
            "status": 1,
            "user_count": 32,
            "resource": "groups",
            "description": "",
            "created_at": "2017-11-02T12:11:11.210052",
            "modified_at": "2017-11-02T12:11:11.210072",
            "uuid_url": "NMC-zgOjR7GW88Z-GCjZeQ",
            "resource_uri": {
                "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/",
                "href": "/api/v1/groups/NMC-zgOjR7GW88Z-GCjZeQ",
                "users": "/api/v1/groups/NMC-zgOjR7GW88Z-GCjZeQ/users/",
                "permissions": "/api/v1/groups/NMC-zgOjR7GW88Z-GCjZeQ/permissions/"
            },
            "group_type": 2,
            "name": "demoGrp"
        },
        {
            "status": 1,
            "user_count": 1,
            "resource": "groups",
            "description": "",
            "created_at": "2018-06-19T07:53:24.104005",
            "modified_at": "2018-06-19T07:53:24.104024",
            "uuid_url": "0LtQnsKQSAWZoP-OiHl21g",
            "resource_uri": {
                "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/",
                "href": "/api/v1/groups/0LtQnsKQSAWZoP-OiHl21g",
                "users": "/api/v1/groups/0LtQnsKQSAWZoP-OiHl21g/users/",
                "permissions": "/api/v1/groups/0LtQnsKQSAWZoP-OiHl21g/permissions/"
            },
            "group_type": 4,
            "name": "Overlay group"
        }
    ]
}

  1. Run the List applications operation and store the relevant applicationId.

  2. Ensure you have your contractId query parameter.

  3. Optionally, set expand to true to include additional members in the response.

  4. Make a GET request to /crux/v1/mgmt-pop/apps/{applicationId}/groups{?contractId,expand}.

Create a group

Creates a new group.

POST /crux/v1/mgmt-pop/groups{?contractId}

Sample: /crux/v1/mgmt-pop/groups?contractId=F-EMGSGV

Content-Type: application/json

Object type: Group

Download schema: groups.json

Request body:

{
    "status": 1,
    "group_type": 4,
    "name": "Goup 1",
    "description": "A brief description of the group."
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Group

Download schema: group.json

Response body:

{
    "status": 1,
    "user_count": 175,
    "resource": "groups",
    "description": "",
    "created_at": "2017-10-30T10:12:03.783055",
    "modified_at": "2017-10-30T10:12:03.783080",
    "uuid_url": "lDezLHf5QaeFYJyaWOHqAw",
    "resource_uri": {
        "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/",
        "href": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw",
        "users": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw/users/",
        "permissions": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw/permissions/"
    },
    "group_type": 2,
    "name": "Domain Users"
}

  1. Build a new Group object.

  2. POST the object to /crux/v1/mgmt-pop/groups.

  3. The operation responds with a Group object.

Get a group

Gets a single group.

GET /crux/v1/mgmt-pop/groups/{group_id}{?contractId}

Sample: /crux/v1/mgmt-pop/groups/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
group_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each group.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Group

Download schema: group.json

Response body:

{
    "status": 1,
    "user_count": 175,
    "resource": "groups",
    "description": "",
    "created_at": "2017-10-30T10:12:03.783055",
    "modified_at": "2017-10-30T10:12:03.783080",
    "uuid_url": "lDezLHf5QaeFYJyaWOHqAw",
    "resource_uri": {
        "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/",
        "href": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw",
        "users": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw/users/",
        "permissions": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw/permissions/"
    },
    "group_type": 2,
    "name": "Domain Users"
}

  1. Run the List Groups operation and store the relevant id.

  2. Make a GET request to /crux/v1/mgmt-pop/groups/{id}.

  3. The operation responds with a Group object.

Modify a group

Updates an existing group.

PUT /crux/v1/mgmt-pop/groups/{group_id}{?contractId}

Sample: /crux/v1/mgmt-pop/groups/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Content-Type: application/json

Object type: Group

Download schema: group.json

Request body:

{
    "status": 1,
    "user_count": 1,
    "resource": "groups",
    "description": "aad",
    "created_at": "2018-06-19T07:53:24.104005",
    "modified_at": "2018-06-19T07:53:24.104024",
    "group_type": 4,
    "name": "Overlay group"
}
Parameter Type Sample Description
URL path parameters
group_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each group.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Object type: Group

Download schema: group.json

Response body:

{
    "status": 1,
    "user_count": 175,
    "resource": "groups",
    "description": "",
    "created_at": "2017-10-30T10:12:03.783055",
    "modified_at": "2017-10-30T10:12:03.783080",
    "uuid_url": "lDezLHf5QaeFYJyaWOHqAw",
    "resource_uri": {
        "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw/",
        "href": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw",
        "users": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw/users/",
        "permissions": "/api/v1/groups/lDezLHf5QaeFYJyaWOHqAw/permissions/"
    },
    "group_type": 2,
    "name": "Domain Users"
}

  1. Run the List Groups operation and store the relevant id.

  2. Run the Get a Group operation and store the response object.

  3. Modify the Group object.

  4. PUT the object to /crux/v1/mgmt-pop/groups/{id}.

  5. The operation responds with a Group object.

Delete a group

Deletes an existing group.

DELETE /crux/v1/mgmt-pop/groups/{group_id}{?contractId}

Sample: /crux/v1/mgmt-pop/groups/ojxkXzwyQZiBkoRee0XcnA?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
group_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each group.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

  1. Run the List Groups operation and store the relevant id.

  2. Make a DELETE request to /crux/v1/mgmt-pop/groups/{id}.

List group users

Gets a list of users for a group.

GET /crux/v1/mgmt-pop/groups/{group_id}/users{?contractId,offset,limit}

Sample: /crux/v1/mgmt-pop/groups/ojxkXzwyQZiBkoRee0XcnA/users?contractId=F-EMGSGV&offset=10&limit=30

Parameter Type Sample Description
URL path parameters
group_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each group.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: User

Download schema: users.json

Response body:

{
    "meta": {
        "previous": null,
        "total_count": 204,
        "offset": 0,
        "limit": 10,
        "next": "?limit=10&expand=true&offset=10"
    },
    "objects": [
        {
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "last_name": "",
            "user_type": 2,
            "country_code": 0,
            "first_name": "newuser12",
            "display_name": "",
            "last_admin_login": null,
            "normalized_attributes": {
                "user.phoneNumber": [],
                "eaa.demo": [],
                "user.groups": [
                    "CN=demogroup,CN=Users,DC=eaatest,DC=daredevils,DC=com"
                ],
                "user.userName": "newuser12",
                "eaa.test": [],
                "user.email": "",
                "user.lastName": [],
                "user.firstName": "newuser12",
                "eaa.userName": "newuser12@eaatest.daredevils.com",
                "user.netbios": "EAATEST",
                "user.persistentId": "21f7150a-499f-4c87-833e-16818146bd5d",
                "user.samAccountName": "newuser12",
                "user.countryCode": 0,
                "user.userPrincipleName": "newuser12@eaatest.daredevils.com"
            },
            "uuid_url": "P0M1yazIRsWaod0sMt2sGg",
            "last_login": null,
            "registered": false,
            "dn": "CN=newuser12,CN=Users,DC=eaatest,DC=daredevils,DC=com",
            "phone_num": "",
            "samaccountname": "newuser12",
            "password_set": false,
            "url_valid": false,
            "attrib_hash": "49a5237caf14789fab7635cd9105aa58",
            "groups": [
                {
                    "group_membership_uuid_uurl": "yu9hLsVBSgW4-0NCG0u4BQ",
                    "name": "Domain Users",
                    "uuid_url": "lDezLHf5QaeFYJyaWOHqAw"
                }
            ],
            "password": null,
            "netbios": "EAATEST",
            "upn": "newuser12@eaatest.daredevils.com",
            "last_accessed_tenant_uuid_url": null,
            "modified_at": "2019-07-02T13:55:20.880278",
            "email": "",
            "username": "newuser12@eaatest.daredevils.com",
            "status": 0,
            "mfa_reset": false,
            "url_timestamp": "2017-10-30T10:12:05.262165",
            "created_at": "2017-10-30T10:12:05.261965",
            "resource_uri": {
                "directory": "/api/v1/directories/aAgAKK45R6-uLK5U8o2iKw",
                "href": "/api/v1/users/P0M1yazIRsWaod0sMt2sGg",
                "groups": "/api/v1/users/P0M1yazIRsWaod0sMt2sGg/groups/",
                "permissions": "/api/v1/users/P0M1yazIRsWaod0sMt2sGg/permissions/"
            }
        }
    ]
}

  1. Run the List Groups operation and store the relevant id.

  2. Optionally, set the offset and limit query parameters.

  3. Make a GET request to /crux/v1/mgmt-pop/groups/{id}/users{?offset,limit}.

  4. The operation responds with a User object.

Sync group

Synchronizes an external user group with EAA.

POST /crux/v1/mgmt-pop/groups/{group_id}/sync{?contractId}

Sample: /crux/v1/mgmt-pop/groups/ojxkXzwyQZiBkoRee0XcnA/sync?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
group_id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each group.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: sync-group-users.json

Response body:

{
    "response": "Syncing Group demoGrp"
}

  1. Run the List Groups operation and store the relevant id.

  2. Make a POST request to /crux/v1/mgmt-pop/groups/{id}/sync.

  3. The operation responds with a single-member object containing a confirmation message.

Reset OTP

Resets the one time password (OTP) of a user.

POST /crux/v1/mgmt-pop/tenant/mfa/reset{?contractId}

Sample: /crux/v1/mgmt-pop/tenant/mfa/reset?contractId=F-EMGSGV

Content-Type: application/json

Download schema: mfauser.json

Request body:

{
    "user_id": "UcxX2qmATBeyADMt2oRxNw",
    "otp_type": "login_mfa"
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: mfauser.json

Response body:

{
    "status": "success"
}

  1. Ensure you have your contractId query parameter.

  2. Build a new ResetOTP object.

  3. POST the object to /crux/v1/mgmt-pop/tenant/mfa/reset{?contractId}.

  4. The operation responds with a single member object containing the status of the request.

List rules

Returns a list of rules.

GET /crux/v1/mgmt-pop/rules{?contractId,offset,limit}

Sample: /crux/v1/mgmt-pop/rules?contractId=F-EMGSGV&offset=10&limit=30

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Download schema: rules-list.json

Response body:

{
    "meta": {
        "previous": null,
        "total_count": 1,
        "offset": 0,
        "limit": 1000,
        "next": null
    },
    "objects": [
        {
            "rule_type": 1,
            "status": 1,
            "description": null,
            "settings": [
                {
                    "operator": "==",
                    "type": "user",
                    "value": "sd"
                }
            ],
            "created_at": "2019-07-17T10:47:25.588550",
            "modified_at": "2019-07-17T10:48:23.377706",
            "uuid_url": "3dnJ7oNoTzm9lYSaLRGAdg",
            "action": 1,
            "global_rule": false,
            "merge_global": true,
            "resource_uri": {
                "href": "/api/v1/rules/3dnJ7oNoTzm9lYSaLRGAdg",
                "service": "/api/v1/services/b-IAzsVvQfeTT5DTEiXZuw"
            },
            "name": "rule#1"
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. For pagination, set offset the number of members to skip in the object list.

  3. For a pagination, set limit to specify the maximum number of members to return in the response.

  4. Make a GET request to /crux/v1/mgmt-pop/rules{?contractId,offset,limit}.

  5. The operation responds with a list of Rule objects.

Create a rule

Creates a new rule.

POST /crux/v1/mgmt-pop/rules{?contractId}

Sample: /crux/v1/mgmt-pop/rules?contractId=F-EMGSGV

Content-Type: application/json

Download schema: rules-list.json

Request body:

{
    "rule_type": 1,
    "name": "rule#1"
}
Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200 application/json

Download schema: rules-list.json

Response body:

{
    "action": 1,
    "created_at": "2019-07-17T10:47:25.588550",
    "description": null,
    "global_rule": false,
    "merge_global": true,
    "modified_at": "2019-07-17T10:47:25.588564",
    "name": "rule#1",
    "partner_uuid": "e2901d96-cc1b-41fc-906c-e29135cc1fe0",
    "partner_uuid_url": "4pAdlswbQfyQbOKRNcwf4A",
    "resource_uri": {
        "href": "/api/v1/rules/3dnJ7oNoTzm9lYSaLRGAdg",
        "service": "/api/v1/services/b-IAzsVvQfeTT5DTEiXZuw"
    },
    "rule_type": 1,
    "service": "b-IAzsVvQfeTT5DTEiXZuw",
    "status": 1,
    "tenant_uuid": "bfaecce4-2b73-4768-9f5c-e8da2479d8e2",
    "uuid_url": "3dnJ7oNoTzm9lYSaLRGAdg"
}

  1. Ensure you have your contractId query parameter.

  2. Build a new Rule object.

  3. POST the object to /crux/v1/mgmt-pop/rules{?contractId}.

  4. The operation responds with a Rule object.

Get a rule

Returns a single rule by ID.

GET /crux/v1/mgmt-pop/rules/{id}

Sample: /crux/v1/mgmt-pop/rules/ojxkXzwyQZiBkoRee0XcnA

Parameter Type Sample Description
URL path parameters
id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each resource.

Status 200 application/json

Download schema: rules-list.json

Response body:

{
    "rule_type": 1,
    "status": 1,
    "description": null,
    "settings": [
        {
            "operator": "==",
            "type": "user",
            "value": "sd"
        }
    ],
    "created_at": "2019-07-17T10:47:25.588550",
    "modified_at": "2019-07-17T10:48:23.377706",
    "uuid_url": "3dnJ7oNoTzm9lYSaLRGAdg",
    "action": 1,
    "global_rule": false,
    "merge_global": true,
    "resource_uri": {
        "href": "/api/v1/rules/3dnJ7oNoTzm9lYSaLRGAdg",
        "service": "/api/v1/services/b-IAzsVvQfeTT5DTEiXZuw"
    },
    "name": "rule#1"
}

  1. Run the List Rules operation and store the relevant id.

  2. Make a GET request to /crux/v1/mgmt-pop/rules/{id}.

  3. The operation responds with a Rule object.

Modify a rule

Updates an existing rule.

PUT /crux/v1/mgmt-pop/rules/{id}

Sample: /crux/v1/mgmt-pop/rules/ojxkXzwyQZiBkoRee0XcnA

Content-Type: application/json

Download schema: rules-list.json

Request body:

{
    "action": 1,
    "created_at": "2019-07-17T10:47:25.588550",
    "description": null,
    "global_rule": false,
    "merge_global": true,
    "modified_at": "2019-07-17T10:47:25.588564",
    "name": "rule#1",
    "partner_uuid": "e2901d96-cc1b-41fc-906c-e29135cc1fe0",
    "partner_uuid_url": "4pAdlswbQfyQbOKRNcwf4A",
    "rule_type": 1,
    "service": "b-IAzsVvQfeTT5DTEiXZuw",
    "status": 1,
    "tenant_uuid": "bfaecce4-2b73-4768-9f5c-e8da2479d8e2",
    "settings": [
        {
            "type": "user",
            "value": "sd",
            "operator": "=="
        }
    ]
}
Parameter Type Sample Description
URL path parameters
id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each resource.

Status 200 application/json

Download schema: rules-list.json

Response body:

{
    "rule_type": 1,
    "status": 1,
    "description": null,
    "settings": [
        {
            "operator": "==",
            "type": "user",
            "value": "sd"
        }
    ],
    "created_at": "2019-07-17T10:47:25.588550",
    "modified_at": "2019-07-17T10:48:23.377706",
    "uuid_url": "3dnJ7oNoTzm9lYSaLRGAdg",
    "action": 1,
    "global_rule": false,
    "merge_global": true,
    "resource_uri": {
        "href": "/api/v1/rules/3dnJ7oNoTzm9lYSaLRGAdg",
        "service": "/api/v1/services/b-IAzsVvQfeTT5DTEiXZuw"
    },
    "name": "rule#1"
}

  1. Run the List Rules operation and store the relevant id.

  2. Run the Get a Rule operation and store the response object.

  3. Modify the Rule object.

  4. PUT the object to /crux/v1/mgmt-pop/rules/{id}.

  5. The operation responds with the updated Rule object.

Delete a rule

Deletes an existing rule.

DELETE /crux/v1/mgmt-pop/rules/{id}

Sample: /crux/v1/mgmt-pop/rules/ojxkXzwyQZiBkoRee0XcnA

Parameter Type Sample Description
URL path parameters
id String ojxkXzwyQZiBkoRee0XcnA A unique identifier for each resource.

Status 200

List users

Gets a list of user accounts.

GET /crux/v1/mgmt-pop/users{?contractId,offset,limit,expand}

Sample: /crux/v1/mgmt-pop/users?contractId=F-EMGSGV&offset=10&limit=30&expand=true

Parameter Type Sample Description
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.
Optional query parameters
expand Boolean true When set to true, includes additional members in the request.
limit Integer 30 Used for pagination. The total number of list members to return after the offset in the request.
offset Integer 10 Used for pagination. The first member of the underlying object list to be returned in the request.

Status 200 application/json

Object type: User

Download schema: users.json

Response body:

{
    "meta": {
        "limit": 10,
        "next": "?expand=true&limit=10&offset=10",
        "offset": 0,
        "previous": null,
        "total_count": 31
    },
    "objects": [
        {
            "attrib_hash": null,
            "blocked_idps": [
                {
                    "idp_uuid_url": "xz_HqmAdSNeSnoCWss9Phg"
                }
            ],
            "country_code": null,
            "created_at": "2017-01-04T14:58:31.246142",
            "display_name": "",
            "dn": "",
            "email": "bala7@bwrapp.com",
            "first_name": "bala",
            "groups": [
                {
                    "group_membership_uuid_uurl": "PwOgv5QTSI6UeBxRdcaBJA",
                    "name": "\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3 \u30af\u30b9\u30c6\u30c3",
                    "uuid_url": "cYhiBMQNQb-xMSXNBHLrwQ"
                },
                {
                    "group_membership_uuid_uurl": "H6FiLbkyRnGZipI69LH1Ow",
                    "name": "Users",
                    "uuid_url": "a8NmcsRWTau-XXQdDYVkgQ"
                },
                {
                    "group_membership_uuid_uurl": "Xbqbdo_PTYWX0A3QMRCqYQ",
                    "name": "Admins",
                    "uuid_url": "cmsvv_YkTY2rcoeOS5cIzg"
                }
            ],
            "last_accessed_tenant_uuid_url": "qzRLlvlzTju1YM4Yupj3EA",
            "last_admin_login": "2020-10-05T12:17:17.432695",
            "last_login": "2017-05-24T07:51:45.823741",
            "last_name": "7",
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "mfa_reset": true,
            "modified_at": "2020-10-05T12:17:17.437210",
            "netbios": null,
            "normalized_attributes": {
                "user.countryCode": null,
                "user.email": "bala7@bwrapp.com",
                "user.firstName": "bala",
                "user.lastName": "7",
                "user.netbios": null,
                "user.phoneNumber": null,
                "user.samAccountName": null,
                "user.userPrincipleName": null
            },
            "password": null,
            "password_set": true,
            "phone_num": null,
            "registered": false,
            "resource_uri": {
                "directory": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
                "groups": "/api/v1/users/wsJ7xkh2QGOoIHF8q7wfMg/groups/",
                "href": "/api/v1/users/wsJ7xkh2QGOoIHF8q7wfMg",
                "permissions": "/api/v1/users/wsJ7xkh2QGOoIHF8q7wfMg/permissions/"
            },
            "samaccountname": null,
            "status": 1,
            "upn": null,
            "url_timestamp": "2017-01-04T14:58:31.246215",
            "url_valid": false,
            "user_type": 1,
            "username": "bala7@bwrapp.com",
            "uuid_url": "wsJ7xkh2QGOoIHF8q7wfMg"
        },
        {
            "attrib_hash": null,
            "blocked_idps": [],
            "country_code": null,
            "created_at": "2018-09-14T09:18:22.625320",
            "display_name": "",
            "dn": "",
            "email": "jap1@akamai.com",
            "first_name": "\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30b9\u30c8",
            "groups": [
                {
                    "group_membership_uuid_uurl": "RI2Sch3xTWueGmqA5wgfFA",
                    "name": "\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3 \u30af\u30b9\u30c6\u30c3",
                    "uuid_url": "cYhiBMQNQb-xMSXNBHLrwQ"
                },
                {
                    "group_membership_uuid_uurl": "O1M7Cp_bQcymMe2TlPGarQ",
                    "name": "\"\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\"",
                    "uuid_url": "Vl8y9IdwQJqPpKtJcJNnGw"
                },
                {
                    "group_membership_uuid_uurl": "4YpBhOV1Q62oGqXEhPvA8g",
                    "name": "\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30b9",
                    "uuid_url": "e0sq-8X4RUCDDinaVG1BFg"
                },
                {
                    "group_membership_uuid_uurl": "cn48SRb2QKaBUC0TGXhylg",
                    "name": "Users",
                    "uuid_url": "a8NmcsRWTau-XXQdDYVkgQ"
                }
            ],
            "last_accessed_tenant_uuid_url": null,
            "last_admin_login": null,
            "last_login": null,
            "last_name": "tes",
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "mfa_reset": false,
            "modified_at": "2018-09-14T09:18:22.648896",
            "netbios": null,
            "normalized_attributes": {
                "user.countryCode": null,
                "user.email": "jap1@akamai.com",
                "user.firstName": "\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30b9\u30c8",
                "user.lastName": "tes",
                "user.netbios": null,
                "user.phoneNumber": null,
                "user.samAccountName": null,
                "user.userPrincipleName": null
            },
            "password": null,
            "password_set": true,
            "phone_num": null,
            "registered": false,
            "resource_uri": {
                "directory": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
                "groups": "/api/v1/users/iSQp9d7tTJGxlwlKh01XEw/groups/",
                "href": "/api/v1/users/iSQp9d7tTJGxlwlKh01XEw",
                "permissions": "/api/v1/users/iSQp9d7tTJGxlwlKh01XEw/permissions/"
            },
            "samaccountname": null,
            "status": 1,
            "upn": null,
            "url_timestamp": "2018-09-14T09:18:22.625391",
            "url_valid": false,
            "user_type": 1,
            "username": "jap1@akamai.com",
            "uuid_url": "iSQp9d7tTJGxlwlKh01XEw"
        },
        {
            "attrib_hash": null,
            "blocked_idps": [],
            "country_code": null,
            "created_at": "2018-09-14T14:07:07.405786",
            "display_name": "",
            "dn": "",
            "email": "nselvam1@akamai.com",
            "first_name": "\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30b9\u30c8",
            "groups": [
                {
                    "group_membership_uuid_uurl": "ew307oMITWK6nBYSyCzN4w",
                    "name": "\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30b9",
                    "uuid_url": "e0sq-8X4RUCDDinaVG1BFg"
                },
                {
                    "group_membership_uuid_uurl": "ejJXem6VQTalwek2M4xMfg",
                    "name": "Users",
                    "uuid_url": "a8NmcsRWTau-XXQdDYVkgQ"
                }
            ],
            "last_accessed_tenant_uuid_url": null,
            "last_admin_login": null,
            "last_login": null,
            "last_name": "\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30b9\u30c8",
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "mfa_reset": false,
            "modified_at": "2018-09-14T14:07:07.427423",
            "netbios": null,
            "normalized_attributes": {
                "user.countryCode": null,
                "user.email": "nselvam1@akamai.com",
                "user.firstName": "\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30b9\u30c8",
                "user.lastName": "\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30b9\u30c8",
                "user.netbios": null,
                "user.phoneNumber": null,
                "user.samAccountName": null,
                "user.userPrincipleName": null
            },
            "password": null,
            "password_set": true,
            "phone_num": null,
            "registered": false,
            "resource_uri": {
                "directory": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
                "groups": "/api/v1/users/Cf9rDljHQCm09yBd2xP7Gw/groups/",
                "href": "/api/v1/users/Cf9rDljHQCm09yBd2xP7Gw",
                "permissions": "/api/v1/users/Cf9rDljHQCm09yBd2xP7Gw/permissions/"
            },
            "samaccountname": null,
            "status": 1,
            "upn": null,
            "url_timestamp": "2018-09-14T14:07:07.405855",
            "url_valid": false,
            "user_type": 1,
            "username": "nselvam1@akamai.com",
            "uuid_url": "Cf9rDljHQCm09yBd2xP7Gw"
        },
        {
            "attrib_hash": null,
            "blocked_idps": [],
            "country_code": null,
            "created_at": "2018-09-19T13:17:52.029022",
            "display_name": "",
            "dn": "",
            "email": "abc@akamai.com",
            "first_name": "abc",
            "groups": [
                {
                    "group_membership_uuid_uurl": "PhnkJbToTr-2v_5NnTD_XA",
                    "name": "n1\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6\u30b9\u30c6\u30de\u30cd\u30c3\u30af\u30b9\u30c6",
                    "uuid_url": "0fJ5cK2lRfOvL9NB674CHw"
                },
                {
                    "group_membership_uuid_uurl": "Fh5m8rB9QRmq7vTr-tKv2w",
                    "name": "Users",
                    "uuid_url": "a8NmcsRWTau-XXQdDYVkgQ"
                }
            ],
            "last_accessed_tenant_uuid_url": null,
            "last_admin_login": null,
            "last_login": null,
            "last_name": "def",
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "mfa_reset": false,
            "modified_at": "2018-09-19T13:17:52.047455",
            "netbios": null,
            "normalized_attributes": {
                "user.countryCode": null,
                "user.email": "abc@akamai.com",
                "user.firstName": "abc",
                "user.lastName": "def",
                "user.netbios": null,
                "user.phoneNumber": null,
                "user.samAccountName": null,
                "user.userPrincipleName": null
            },
            "password": null,
            "password_set": true,
            "phone_num": null,
            "registered": false,
            "resource_uri": {
                "directory": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
                "groups": "/api/v1/users/0ifVzGxwR1uKq3Lnoau47w/groups/",
                "href": "/api/v1/users/0ifVzGxwR1uKq3Lnoau47w",
                "permissions": "/api/v1/users/0ifVzGxwR1uKq3Lnoau47w/permissions/"
            },
            "samaccountname": null,
            "status": 1,
            "upn": null,
            "url_timestamp": "2018-09-19T13:17:52.029093",
            "url_valid": false,
            "user_type": 1,
            "username": "abc@akamai.com",
            "uuid_url": "0ifVzGxwR1uKq3Lnoau47w"
        },
        {
            "attrib_hash": null,
            "blocked_idps": [],
            "country_code": null,
            "created_at": "2019-02-20T19:58:51.842770",
            "display_name": "",
            "dn": "",
            "email": "bgalpha3@mailinator.com",
            "first_name": "s",
            "groups": [
                {
                    "group_membership_uuid_uurl": "0mvHnf98S2CMgAEjDPQuhg",
                    "name": "Users",
                    "uuid_url": "a8NmcsRWTau-XXQdDYVkgQ"
                }
            ],
            "last_accessed_tenant_uuid_url": null,
            "last_admin_login": null,
            "last_login": null,
            "last_name": "s",
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "mfa_reset": false,
            "modified_at": "2019-02-20T20:03:04.323683",
            "netbios": null,
            "normalized_attributes": {
                "user.countryCode": null,
                "user.email": "bgalpha3@mailinator.com",
                "user.firstName": "s",
                "user.lastName": "s",
                "user.netbios": null,
                "user.phoneNumber": null,
                "user.samAccountName": null,
                "user.userPrincipleName": null
            },
            "password": null,
            "password_set": true,
            "phone_num": null,
            "registered": true,
            "resource_uri": {
                "directory": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
                "groups": "/api/v1/users/v99WkNUBTZyYKC486CDH-Q/groups/",
                "href": "/api/v1/users/v99WkNUBTZyYKC486CDH-Q",
                "permissions": "/api/v1/users/v99WkNUBTZyYKC486CDH-Q/permissions/"
            },
            "samaccountname": null,
            "status": 1,
            "upn": null,
            "url_timestamp": "2019-02-20T20:03:04.311533",
            "url_valid": true,
            "user_type": 1,
            "username": "bgalpha3@mailinator.com",
            "uuid_url": "v99WkNUBTZyYKC486CDH-Q"
        },
        {
            "attrib_hash": null,
            "blocked_idps": [],
            "country_code": null,
            "created_at": "2019-07-02T07:16:50.517338",
            "display_name": "",
            "dn": "",
            "email": "ram2@abc.com",
            "first_name": "ram",
            "groups": [
                {
                    "group_membership_uuid_uurl": "X_FIetcfR0SNh_0yX09AIA",
                    "name": "Users",
                    "uuid_url": "a8NmcsRWTau-XXQdDYVkgQ"
                }
            ],
            "last_accessed_tenant_uuid_url": null,
            "last_admin_login": null,
            "last_login": null,
            "last_name": "2",
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "mfa_reset": false,
            "modified_at": "2019-07-02T07:16:50.561194",
            "netbios": null,
            "normalized_attributes": {
                "user.countryCode": null,
                "user.email": "ram2@abc.com",
                "user.firstName": "ram",
                "user.lastName": "2",
                "user.netbios": null,
                "user.phoneNumber": null,
                "user.samAccountName": null,
                "user.userPrincipleName": null
            },
            "password": null,
            "password_set": true,
            "phone_num": null,
            "registered": false,
            "resource_uri": {
                "directory": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
                "groups": "/api/v1/users/qajJdQf4RDi4UFYjJC1yfQ/groups/",
                "href": "/api/v1/users/qajJdQf4RDi4UFYjJC1yfQ",
                "permissions": "/api/v1/users/qajJdQf4RDi4UFYjJC1yfQ/permissions/"
            },
            "samaccountname": null,
            "status": 1,
            "upn": null,
            "url_timestamp": "2019-07-02T07:16:50.517398",
            "url_valid": false,
            "user_type": 1,
            "username": "ram2@abc.com",
            "uuid_url": "qajJdQf4RDi4UFYjJC1yfQ"
        },
        {
            "attrib_hash": null,
            "blocked_idps": [],
            "country_code": null,
            "created_at": "2019-07-02T18:22:13.333694",
            "display_name": "",
            "dn": "",
            "email": "ram4@abc.com",
            "first_name": "ram",
            "groups": [
                {
                    "group_membership_uuid_uurl": "YBYHQIpgT4GXHzvYwZSdrQ",
                    "name": "Users",
                    "uuid_url": "a8NmcsRWTau-XXQdDYVkgQ"
                }
            ],
            "last_accessed_tenant_uuid_url": null,
            "last_admin_login": null,
            "last_login": null,
            "last_name": "4",
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "mfa_reset": false,
            "modified_at": "2019-07-02T18:22:13.349100",
            "netbios": null,
            "normalized_attributes": {
                "user.countryCode": null,
                "user.email": "ram4@abc.com",
                "user.firstName": "ram",
                "user.lastName": "4",
                "user.netbios": null,
                "user.phoneNumber": null,
                "user.samAccountName": null,
                "user.userPrincipleName": null
            },
            "password": null,
            "password_set": true,
            "phone_num": null,
            "registered": false,
            "resource_uri": {
                "directory": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
                "groups": "/api/v1/users/asuikKfhROmsLCGF6bPxfg/groups/",
                "href": "/api/v1/users/asuikKfhROmsLCGF6bPxfg",
                "permissions": "/api/v1/users/asuikKfhROmsLCGF6bPxfg/permissions/"
            },
            "samaccountname": null,
            "status": 1,
            "upn": null,
            "url_timestamp": "2019-07-02T18:22:13.333754",
            "url_valid": false,
            "user_type": 1,
            "username": "ram4@abc.com",
            "uuid_url": "asuikKfhROmsLCGF6bPxfg"
        },
        {
            "attrib_hash": null,
            "blocked_idps": [],
            "country_code": null,
            "created_at": "2019-07-11T10:57:21.867408",
            "display_name": "",
            "dn": "",
            "email": "newer@test.com",
            "first_name": "first",
            "groups": [
                {
                    "group_membership_uuid_uurl": "MSo_2buYSH6Fv2YI4d1OtA",
                    "name": "Users",
                    "uuid_url": "a8NmcsRWTau-XXQdDYVkgQ"
                }
            ],
            "last_accessed_tenant_uuid_url": null,
            "last_admin_login": null,
            "last_login": null,
            "last_name": "last",
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "mfa_reset": false,
            "modified_at": "2019-07-11T10:57:22.539382",
            "netbios": null,
            "normalized_attributes": {
                "user.countryCode": null,
                "user.email": "newer@test.com",
                "user.firstName": "first",
                "user.lastName": "last",
                "user.netbios": null,
                "user.phoneNumber": null,
                "user.samAccountName": null,
                "user.userPrincipleName": null
            },
            "password": null,
            "password_set": false,
            "phone_num": null,
            "registered": false,
            "resource_uri": {
                "directory": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
                "groups": "/api/v1/users/-MNKXq9PTA6eS65cFtPsYw/groups/",
                "href": "/api/v1/users/-MNKXq9PTA6eS65cFtPsYw",
                "permissions": "/api/v1/users/-MNKXq9PTA6eS65cFtPsYw/permissions/"
            },
            "samaccountname": null,
            "status": 1,
            "upn": null,
            "url_timestamp": "2019-07-09T11:24:07.566631",
            "url_valid": true,
            "user_type": 1,
            "username": "newer@test.com",
            "uuid_url": "-MNKXq9PTA6eS65cFtPsYw"
        },
        {
            "attrib_hash": null,
            "blocked_idps": [],
            "country_code": null,
            "created_at": "2019-07-11T10:59:10.748385",
            "display_name": "",
            "dn": "",
            "email": "neweee@test.com",
            "first_name": "first",
            "groups": [
                {
                    "group_membership_uuid_uurl": "7CaUuBmhT_mZlWd7nEs2zg",
                    "name": "Users",
                    "uuid_url": "a8NmcsRWTau-XXQdDYVkgQ"
                }
            ],
            "last_accessed_tenant_uuid_url": null,
            "last_admin_login": null,
            "last_login": null,
            "last_name": "last",
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "mfa_reset": false,
            "modified_at": "2019-07-11T10:59:10.763311",
            "netbios": null,
            "normalized_attributes": {
                "user.countryCode": null,
                "user.email": "neweee@test.com",
                "user.firstName": "first",
                "user.lastName": "last",
                "user.netbios": null,
                "user.phoneNumber": null,
                "user.samAccountName": null,
                "user.userPrincipleName": null
            },
            "password": null,
            "password_set": true,
            "phone_num": null,
            "registered": false,
            "resource_uri": {
                "directory": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
                "groups": "/api/v1/users/xC3utBTMTh2BPnVEI9yAUA/groups/",
                "href": "/api/v1/users/xC3utBTMTh2BPnVEI9yAUA",
                "permissions": "/api/v1/users/xC3utBTMTh2BPnVEI9yAUA/permissions/"
            },
            "samaccountname": null,
            "status": 1,
            "upn": null,
            "url_timestamp": "2019-07-11T10:59:10.748449",
            "url_valid": false,
            "user_type": 1,
            "username": "neweee@test.com",
            "uuid_url": "xC3utBTMTh2BPnVEI9yAUA"
        },
        {
            "attrib_hash": null,
            "blocked_idps": [],
            "country_code": null,
            "created_at": "2019-07-11T10:59:56.255924",
            "display_name": "",
            "dn": "",
            "email": "newer1@test.com",
            "first_name": "first",
            "groups": [
                {
                    "group_membership_uuid_uurl": "V_olPwKDTWiL0PKj0nfgXA",
                    "name": "Users",
                    "uuid_url": "a8NmcsRWTau-XXQdDYVkgQ"
                }
            ],
            "last_accessed_tenant_uuid_url": null,
            "last_admin_login": null,
            "last_login": null,
            "last_name": "last",
            "mfa": {
                "admin_mfa": false,
                "login_mfa": true
            },
            "mfa_reset": false,
            "modified_at": "2019-07-11T10:59:57.031801",
            "netbios": null,
            "normalized_attributes": {
                "user.countryCode": null,
                "user.email": "newer1@test.com",
                "user.firstName": "first",
                "user.lastName": "last",
                "user.netbios": null,
                "user.phoneNumber": null,
                "user.samAccountName": null,
                "user.userPrincipleName": null
            },
            "password": null,
            "password_set": false,
            "phone_num": null,
            "registered": false,
            "resource_uri": {
                "directory": "/api/v1/directories/U59wJq3dQNuanDH8VMc1Gg",
                "groups": "/api/v1/users/iYkME-clS_Ob68DBuq8Jcg/groups/",
                "href": "/api/v1/users/iYkME-clS_Ob68DBuq8Jcg",
                "permissions": "/api/v1/users/iYkME-clS_Ob68DBuq8Jcg/permissions/"
            },
            "samaccountname": null,
            "status": 1,
            "upn": null,
            "url_timestamp": "2019-07-09T11:24:34.494910",
            "url_valid": true,
            "user_type": 1,
            "username": "newer1@test.com",
            "uuid_url": "iYkME-clS_Ob68DBuq8Jcg"
        }
    ]
}

  1. Ensure you have your contractId query parameter.

  2. Make a GET request to /crux/v1/mgmt-pop/users{?contractId}.

  3. The operation responds with a User object.

Create a user

Creates a new user account.

POST /crux/v1/mgmt-pop/users{?contractId}

Sample: /crux/v1/mgmt-pop/users?contractId=F-EMGSGV

Content-Type: application/json

Object type: User

Download schema: user.json

Request body:

{
    "email": "johnsnow@akamai.com",
    "first_name&