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 directories: Specifies the associated directory configuration settings for an application. You create this association by POSTing an AppDirectory object.

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

  • 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).

  • 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.

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 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}
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,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 Fire Wall 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}
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}
Idpdirectory  
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}
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}
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}
Groupmembership  
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}
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 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.

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,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&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.
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.
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.
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, or ios.
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": [],
            "anti_malware_status": "poor",
            "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",
            "csi_signals": {
                "blacklisted": false
            },
            "device_id": "472d4ebbf2a9e9b05c6b1c366fb7df801d0fe59d18cf74e3a15476ba42549c6f",
            "device_name": "mac-device-1",
            "idp_username": "username@akamai.com",
            "firewall_status": "poor",
            "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": [
                {
                    "definitions_update": "",
                    "product_name": "Intego",
                    "version": ""
                }
            ],
            "anti_malware_status": "good",
            "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",
            "csi_signals": {
                "blacklisted": false
            },
            "device_id": "1c962e601cf36b2874ac1112117ccb6d179b3f5d0da7bf4d880d1a3707e0e761",
            "device_name": "mac-device-2",
            "firewall_status": "good",
            "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": [
                {
                    "definitions_update": "",
                    "product_name": "Malwarebytes",
                    "version": ""
                }
            ],
            "anti_malware_status": "good",
            "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",
            "csi_signals": {
                "blacklisted": false
            },
            "device_id": "369b5c8a97e0085f813720f7cbc9753e8b667d8112e49e656713fbaa0dbe5115",
            "device_name": "mac-device-3",
            "firewall_status": "good",
            "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": [],
            "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": false
                }
            ],
            "crowdstrike": {
                "sensor_version": "N/A",
                "last_contact": "2020-08-26T03:10:46+00:00",
                "aid": "7445e54fef9f49059c1b08c72skdhfjk",
                "cid": "b8d9a8c2c8734cf8ab68c0a9rehfuegf",
                "validity": "Valid",
                "agent_status": "Healthy"
            },
            "client_version": "0.9",
            "csi_signals": {
                "blacklisted": false
            },
            "device_biometric": true,
            "device_id": "4B1CF385-01F3-4711-96B7-3A3DD7E354F9",
            "device_jailbroken": false,
            "device_name": "iPhone",
            "device_screen_lock": true,
            "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": [],
            "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": false
                },
                {
                    "name": "Certificate Profile 3",
                    "passed": false
                }
            ],
            "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.9",
            "csi_signals": {
                "blacklisted": false
            },
            "device_biometric": true,
            "device_id": "128DCDE5-ACB0-411A-8428-5BEAAD983D0C",
            "device_jailbroken": false,
            "device_name": "iPhone",
            "device_screen_lock": true,
            "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 Fire Wall Status

Returns a list of activity metrics for fire wall 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
    }
]

  1. Ensure you have your contractId query parameter.

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

  3. The operation responds with a Signal object.

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_running": true,
            "anti_malware_status": "good",
            "anti_malware_info": [
                {
                    "version": "",
                    "product_name": "Windows Defender",
                    "definitions_update": ""
                }
            ],
            "firewall_status": "poor",
            "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_running": true,
            "anti_malware_status": "good",
            "anti_malware_info": [
                {
                    "version": "",
                    "product_name": "Windows Defender",
                    "definitions_update": ""
                }
            ],
            "firewall_status": "poor",
            "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_running": true,
            "anti_malware_status": "good",
            "anti_malware_info": [
                {
                    "version": "",
                    "product_name": "Windows Defender",
                    "definitions_update": ""
                }
            ],
            "firewall_status": "poor",
            "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_running": true,
            "anti_malware_status": "good",
            "anti_malware_info": [
                {
                    "version": "",
                    "product_name": "Windows Defender",
                    "definitions_update": ""
                }
            ],
            "firewall_status": "poor",
            "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": "Mac OS X",
        "latest": "10.15.4 (19E287)",
        "date": "2020-04-08",
        "upToDate": [
            {
                "version": "10.14.6",
                "date": "2019-09-26"
            },
            {
                "version": "10.13.6 (17G6030)",
                "date": "2019-03-29"
            },
            {
                "version": "10.12.6 (16G1918)",
                "date": "2019-03-29"
            }
        ]
    },
    {
        "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.0.2",
    "date": "2020-04-24"
}

  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": "Mac OS X",
            "custom": [
                "10.13.6",
                "10.14.6"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Windows",
            "custom": [
                "7601.24533",
                "17763.805",
                "16299.1387",
                "17763.864",
                "17134.1069",
                "7601.24535",
                "7601.24540"
            ],
            "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
        }
    ]
}

  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": "Mac OS X",
            "custom": [
                "10.13.6",
                "10.14.6"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Windows",
            "custom": [
                "7601.24533",
                "17763.805",
                "16299.1387",
                "17763.864",
                "17134.1069",
                "7601.24535",
                "7601.24540"
            ],
            "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
        }
    ]
}
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": "Mac OS X",
            "custom": [
                "10.13.6",
                "10.14.6"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Windows",
            "custom": [
                "7601.24533",
                "17763.805",
                "16299.1387",
                "17763.864",
                "17134.1069",
                "7601.24535",
                "7601.24540"
            ],
            "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
        }
    ]
}
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": "boolean",
        "options": [
            {
                "value": true
            }
        ],
        "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
    }
]

  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": true
                },
                {
                    "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": true
                },
                {
                    "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": true
                    },
                    {
                        "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": true
                    },
                    {
                        "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": true
                    },
                    {
                        "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": true
                }
            ]
        },
        {
            "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": true
                }
            ]
        },
        {
            "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": true
                }
            ]
        },
        {
            "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": true
                }
            ]
        },
        {
            "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.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 200 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/123s?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
certificateProfileId Integer 123s 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.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/123s?contractId=F-EMGSGV

Content-Type: application/json

Download schema: risk-assessment-certificate-profile.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 123s 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/123s?contractId=F-EMGSGV

Parameter Type Sample Description
URL path parameters
certificateProfileId Integer 123s 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 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}.

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 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 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 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 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 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 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 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.

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: Application

Download schema: application.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.

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: Application

Download schema: application.json

Request body:

{
    "email": "johnsnow@akamai.com",
    "first_name": "John",
    "last_name": "Snow",
    "password": "Winter@12345",
    "confirm_password": "Winter@12345"
}
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: User

Download schema: users.json

Response body:

{
    "attrib_hash": null,
    "country_code": null,
    "created_at": "2020-10-05T12:49:44.090438",
    "display_name": "",
    "dn": "",
    "email": "johnsnow@akamai.com",
    "first_name": "John",
    "last_accessed_tenant_uuid_url": null,
    "last_admin_login": null,
    "last_login": null,
    "last_name": "Snow",
    "mfa": {
        "admin_mfa": false,
        "login_mfa": true
    },
    "mfa_reset": false,
    "modified_at": "2020-10-05T12:49:44.115976",
    "netbios": null,
    "normalized_attributes": {
        "user.countryCode": null,
        "user.email": "johnsnow@akamai.com",
        "user.firstName": "John",
        "user.lastName": "Snow",
        "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/eY9q-j8GTCWiWzupFKLYrA/groups/",
        "href": "/api/v1/users/eY9q-j8GTCWiWzupFKLYrA",
        "permissions": "/api/v1/users/eY9q-j8GTCWiWzupFKLYrA/permissions/"
    },
    "samaccountname": null,
    "status": 1,
    "upn": null,
    "url_timestamp": "2020-10-05T12:49:44.090483",
    "url_valid": false,
    "user_type": 1,
    "username": "johnsnow@akamai.com",
    "uuid_url": "eY9q-j8GTCWiWzupFKLYrA"
}

  1. Ensure you have your contractId query parameter.

  2. Build a new User object.

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

  4. The operation responds with a User object.

Get a user

Returns the specified user account.

GET /crux/v1/mgmt-pop/users/{user_id}{?contractId}

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

Parameter Type Sample Description
URL path parameters
user_id String Sbbm0z5iQBmReEd5OyJKfA A unique identifier for the user account.
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:

{
    "attrib_hash": null,
    "country_code": null,
    "created_at": "2017-01-04T14:58:31.246142",
    "display_name": "",
    "dn": "",
    "email": "bala7@bwrapp.com",
    "first_name": "bala",
    "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"
}

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

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

  3. The operation responds with a User object.

Modify a user

Updates a user account.

PUT /crux/v1/mgmt-pop/users/{user_id}{?contractId}

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

Content-Type: application/json

Object type: User

Download schema: users.json

Request body:

{
    "attrib_hash": null,
    "country_code": null,
    "created_at": "2017-01-04T14:58:31.246142",
    "display_name": "",
    "dn": "",
    "email": "bala7@bwrapp.com",
    "first_name": "bala",
    "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,
    "samaccountname": null,
    "status": 1,
    "upn": null,
    "url_timestamp": "2017-01-04T14:58:31.246215",
    "url_valid": false,
    "user_type": 1,
    "username": "bala7@bwrapp.com"
}
Parameter Type Sample Description
URL path parameters
user_id String Sbbm0z5iQBmReEd5OyJKfA A unique identifier for the user account.
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:

{
    "attrib_hash": null,
    "country_code": null,
    "created_at": "2019-07-02T18:21:41.311539",
    "display_name": "",
    "dn": "",
    "email": "ram3@abc.com",
    "first_name": "ram",
    "last_accessed_tenant_uuid_url": null,
    "last_admin_login": null,
    "last_login": null,
    "last_name": "3 test",
    "mfa": {
        "admin_mfa": false,
        "login_mfa": true
    },
    "mfa_reset": false,
    "modified_at": "2020-09-01T08:25:03.019391",
    "netbios": null,
    "normalized_attributes": {
        "user.countryCode": null,
        "user.email": "ram3@abc.com",
        "user.firstName": "ram",
        "user.lastName": "3",
        "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/Sbbm0z5iQBmReEd5OyJKfA/groups/",
        "href": "/api/v1/users/Sbbm0z5iQBmReEd5OyJKfA",
        "permissions": "/api/v1/users/Sbbm0z5iQBmReEd5OyJKfA/permissions/"
    },
    "samaccountname": null,
    "status": 1,
    "upn": null,
    "url_timestamp": "2019-07-02T18:21:41.311602",
    "url_valid": false,
    "user_type": 1,
    "username": "ram3@abc.com",
    "uuid_url": "Sbbm0z5iQBmReEd5OyJKfA"
}

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

  2. Make a PUT request to /crux/v1/mgmt-pop/users/{id}.

  3. The operation responds with a User object.

Delete a user

Deletes a user account.

DELETE /crux/v1/mgmt-pop/users/{user_id}{?contractId}

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

Parameter Type Sample Description
URL path parameters
user_id String Sbbm0z5iQBmReEd5OyJKfA A unique identifier for the user account.
Required query parameters
contractId String F-EMGSGV The Akamai contract identifier for your Enterprise Application Access product.

Status 200

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

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

Data

This section provides details for each type of data object the API exchanges.

Download the JSON schemas for this API.

This section’s data schema tables list membership requirements as follows:

✓ Member is required in requests, or always present in responses, even if its value is empty or null.
○ Member is optional, and may be omitted in some cases.

Application

Encapsulates data about an Enterprise Access Application.

Download schema: application.json

Sample GET response:

{
    "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/"
    }
}

Application members

Member Type Required Description
Application: Encapsulates data about an Enterprise Access Application.
agents Application.agents[] ✓ Specifies the target connectors for deploying the application configuration.
app_category Application.app_category ✓ Specifies the category the application belongs to.
app_deployed Boolean ✓ Whether the application configuration has been deployed.
app_logo String ✓ A URL identifying the application configuration’s logo icon.
app_operational Enumeration ✓ The operational status of the application configuration, either 1 for No, 2 for Pending, or 3 for Okay.
app_profile Enumeration ✓ The access application configuration profile, either 1 for HTTP, 2 for SharePoint, 3 for JIRA, 4 for RDP, 5 for VNC, 6 for SSH, 7 for Jenkins, 8 for Confluence, or 9 for TCP.
app_status Enumeration ✓ The status of the application configuration, either 1 for Not Ready, 2 for Ready, 3 for Pending, 4 for Deployed, 5 for Failed, 6 for Cloud Deployed, or 7 for Connector Deployed.
app_type Enumeration ✓ The type of application configuration, either 1 for Enterprise Hosted, 2 for SAAS, 3 for Bookmark, 4 for Tunnel, or 5 for Enterprise Threat Protector.
auth_agent String, Null ✓ The agent for the application.
auth_enabled String ✓ Whether authentication is enabled.
auth_type Enumeration ✓ The type of authentication used, either 1 for Cloud, 2 for Enterprise, or 3 for Third Party.
bookmark_url String, Null ✓ The Okta Bookmark app URL.
cert String, Null ✓ A valid certificate for front-end SSL connections if you configure your domain as the External Hostname.
client_app_mode Enumeration, Null ✓ The mode of client app. 1 for TCP or 2 for Tunnel.
cname String, Null ✓ The upstream URL for a CNAME redirect.
created_at String ✓ ISO 8601 timestamp marking when the Application object was created.
data_agent String, Null ✓ The data agent for the application.
description String, Null ✓ A description of the application.
directories Application.directories[] ✓ Specifies the directory for validating user accounts.
domain Integer ✓ The type of access domain. Select 1 for custom or 2 for Akamai.
domain_suffix String, Null ✓ The suffix of the access domain. For example, .com.
host String, Null ✓ The external default hostname for the application.
idp Application.idp ✓ Specifies the identity provider (IDP) for authenticating user requests.
modified_at String ✓ Name of the user who most recently modified this Application object. If the object was not modified since first being created, the value matches createdAt.
name String ✓ The name of the application configuration.
oidc Boolean ✓ Whether OpenID Connect (OIDC) is enabled.
oidc_settings Application.oidc_settings ✓ JSON settings to implement OIDC.
origin_host String, Null ✓ The IP address or FQDN of the application origin server.
pop String, Null ✓ The identifier for the target region to deploy the application.
popName String, Null ✓ The target region to deploy the application. For example, US-West or US-East.
rdp_version String, Null ✓ The version of remote desktop protocol (RDP).
resource String, Null ✓ Name of resource mapping to an entity or set of entities. For example, apps.
resource_status Application.resource_status ✓ Encapsulates the most recent status of various application resources.
resource_uri Application.resource_uri ✓ Encapsulates resource URIs associated with the application.
saml Boolean ✓ Whether SAML is enabled.
saml_settings Application.saml_settings[] ✓ Encapsulates SAML configuration for an application.
servers Application.servers[] ✓ Encapsulates origin server details of the internal application within your network.
services Application.services[] ✓ Encapsulates a list of services enabled on the application configuration.
sites Array ✓ List of associated site resources.
uuid_url String ✓ A unique identifier for the application.
wsfed Boolean ✓ Whether WSFED (Web Services Federation) type Identity Federation specification is enabled.
wsfed_settings Application.wsfed_settings[] ✓ Encapsulates Web Services Federation (WSFED) configuration for an application.
Application.agents[]: Specifies the target connectors for deploying the application configuration.
compatible Boolean ✓ Whether the target connector is compatible with the application configuration.
name String ✓ The name of the connector.
uuid_url String ✓ The UUID URL of the connector.
Application.app_category: Specifies the category the application belongs to.
name String ○ The name of the category.
uuid_url String ○ The UUID of the category.
Application.directories[]: Specifies the directory for validating user accounts.
name String ✓ The name of the directory.
type Enumeration ✓ The type of directory. Select 1 for EAA Cloud Directory, 2 for Active Directory, 3 for LDAP, or 4 for Active Directory LDS.
user_count Integer ✓ The total number of user accounts configured on the directory.
uuid_url String ✓ The UUID URL of the directory.
Application.idp: Specifies the identity provider (IDP) for authenticating user requests.
client_cert_auth Boolean ○ Whether certificate-based authentication is enabled for client.
client_cert_user_param String ○ Relevant Cert based parameters for client authentication.
idp_id String ○ The ID of the IDP configuration.
name String ○ The name of the IDP configuration.
type Enumeration, Null ○ The type of IDP. Select 1 for Default, 2 for EAA, 3 for SAML, 4 for Okta, 5 for PingOne, 6 for OneLogin, 7 for Google, 8 for OIDC, or 9 for Azure.
Application.oidc_settings: JSON settings to implement OIDC.
authorization_endpoint String ✓ The open provider endpoint where the end user is asked to authenticate and grant the client application consent to access their identity and any other required information.
certs_uri String ✓ The URI of the relaying party’s CA certificate.
check_session_iframe String ✓ The iframe URL to check session status.
discovery_url String ✓ The open provider endpoint that allows the client to discover OpenID features and other endpoints on the open provider.
end_session_endpoint String ✓ The open provider endpoint that triggers single sign out.
jwks_uri String ✓ The location where JSON web keys (JWK) are published. Present in both the open provider and relaying party.
openid_metadata String ✓ Metadata that describes the open provider’s configuration.
token_endpoint String ✓ The open provider endpoint that tokens and authenticates client application requests.
userinfo_endpoint String ✓ The open provider endpoint where client sends requests for identity claims.
Application.resource_status: Encapsulates the most recent status of various application resources.
cert_status Enumeration ✓ The certificate resource status. Values are 1 for Not Added, 2 for Expired, 3 for Invalid CNAME, 4 for Invalid CA, 5 for No Private Key, 6 for Okay, or 7 for Invalid CA User Parameter.
cname_dns_status Enumeration ✓ The CNAME DNS resource status. Values are 1 for Not Configured, 2 for Configured), 3 for Ready, 4 for Not Resolved, 5 for Okay.
data_agent_status Enumeration ✓ The data agent resource status. Values are 1 for Not Added, 2 for Not Installed, 3 for Not Approved, 4 for Not Reachable, 5 for Okay, or 6 for Not Compatible.
dialin_server_status Enumeration ✓ The dialin server resource status. Values are 1 for Not Configured, 2 for Configured, 3 for Not Created, 4 for Not Resolved, and 5 for Okay.
directories_status Enumeration ✓ The directories resource status. Values are 1 for Not Added, 2 for Added, 3 for No Connector, 4 for Pending, 5 for Not Reachable, or 6 for Okay.
host_dns_status Enumeration ✓ The host DNS resource status. Values are 1 for Not Configured, 2 for Configured, 3 for Ready, 4 for Not Resolved, 5 for Not Created, 6 for Okay, or 7 for CNAME Mismatch.
host_reachable Boolean ✓ Whether the host is reachable.
internal_host_status Enumeration ✓ The internal host resource status. Values are 1 for Not Configured or 2 for Okay.
origin_host_status Enumeration ✓ The origin host resource status. Values are 1 for Not Configured, 2 for Configured, 3 for Ready, 4 for Not Reachable, or 5 for Okay.
pop_status Enumeration ✓ The pop resource status. Values are 1 for Not Configured) or 2 for Okay.
Application.resource_uri: Encapsulates resource URIs associated with the application.
directories String ✓ The URI location of an associated directory resource.
groups String ✓ The URI location of an associated group resource.
href String ✓ The URI location of an associated href resource.
pop String ✓ The URI location of an associated pop resource.
services String ✓ The URI location of an associated service resource.
sites String ✓ The URI location of an associated site resource.
Application.saml_settings[]: Encapsulates SAML configuration for an application.
attrmap Application.saml_settings[].attrmap[] ✓ Specifies mapped attributes for the SAML configuration.
idp Application.saml_settings[].idp ✓ Specifies identity provider (IDP) settings for the SAML configuration.
sp Application.saml_settings[].sp ✓ Specifies service provider (SP) settings for the SAML configuration.
subject Application.saml_settings[].subject ✓ Specifies the subject settings for the SAML configuration.
Application.saml_settings[].attrmap[]: Specifies mapped attributes for the SAML configuration.
fmt String ✓ The name format of the attribute.
fname String, Null ○ The fname of the attribute.
name String ✓ The name of the attribute.
rule String, Null ○ The custom rule language for the attribute.
src String ✓ The source of the attribute.
val String, Null ○ The value of the attribute.
Application.saml_settings[].idp: Specifies identity provider (IDP) settings for the SAML configuration.
ecp_enable Boolean ✓ Whether enhanced client or proxy (ECP) is enabled.
ecp_resp_signature Boolean ✓ The ECP response signature.
entity_id String, Null ✓ The entity ID of the identity provider.
metadata String, Null ✓ Additional metadata for the service provider configuration.
resp_bind Enumeration ✓ The response binding. Set to post.
self_signed Boolean ✓ Whether a self-signed certificate is enabled.
sign_algo Enumeration ✓ The type of signing algorithm, either SHA256 or SHA1.
sign_cert String, Null ✓ The signing certificate.
sign_key String, Null ✓ The signing key.
slo_url String, Null ✓ The single log-out URL.
Application.saml_settings[].sp: Specifies service provider (SP) settings for the SAML configuration.
acs_url String ✓ The single sign-on (ACS) URL.
default_relay_state String, Null ✓ The default relay state.
dst_url String, Null ○ The destination URL.
encr_algo Enumeration ✓ The response encryption algorithm, either aes256-cbc or aes128-cbc.
encr_cert String ✓ The response encryption certificate.
entity_id String ✓ The entity ID.
force_auth Boolean ✓ Whether encryption is forced using the httponly flag in the session cookie.
metadata String, Null ○ Additional metadata for the IDP configuration.
req_bind Enumeration ✓ The response binding, either redirect or post.
req_verify Boolean ✓ Whether verification of requests are enabled.
resp_encr Boolean ✓ Whether the encryption is enabled on the responses.
sign_cert String, Null ○ The request signing certificate.
slo_bind Enumeration ○ The single log-out binding, either post or redirect.
slo_req_verify Boolean ○ Whether verification of single log-out requests are enabled.
slo_url String, Null ○ The single log-out URL.
Application.saml_settings[].subject: Specifies the subject settings for the SAML configuration.
fmt Enumeration ✓ The format for the NameID element of the subject, either email, persistent, unspecified, or transient.
rule String, Null ○ Processing rule for the subject.
src String ✓ The source of the subject.
val String, Null ○ The value of the subject.
Application.servers[]: Encapsulates origin server details of the internal application within your network.
name String ✓ The name of the origin server.
orig_tls Boolean ✓ Whether TLS is enabled on the origin server.
origin_host String, Null ✓ The IP address or FQDN of the origin server.
origin_port Integer ✓ The port number of the origin server.
type String ✓ The protocol of the origin server connection.
Application.services[]: Encapsulates a list of services enabled on the application configuration.
name String ○ The name of the service.
Application.wsfed_settings[]: Encapsulates Web Services Federation (WSFED) configuration for an application.
attrmap Application.wsfed_settings[].attrmap[] ✓ Specifies mapped attributes for the WSFED configuration.
idp Application.wsfed_settings[].idp ✓ Specifies identity provider (IDP) settings for the WSFED configuration.
sp Application.wsfed_settings[].sp ✓ Specifies service provider settings for the WSFED configuration.
subject Application.wsfed_settings[].subject ✓ Specifies subject settings for the WSFED configuration.
Application.wsfed_settings[].attrmap[]: Specifies mapped attributes for the WSFED configuration.
custom_fmt String, Null ○ The custom format of the attribute.
fmt String ✓ The name format of the attribute.
name String, Null ○ The name of the attribute.
rule String, Null ○ The custom rule language for the attribute.
src String, Null ○ The source of the attribute.
val String, Null ○ The value of the attribute.
Application.wsfed_settings[].idp: Specifies identity provider (IDP) settings for the WSFED configuration.
entity_id String ✓ The entity ID of the identity provider.
sign_algo Enumeration ✓ The type of signing algorithm. Either SHA256 or SHA1.
sign_cert String, Null ✓ The signing certificate.
sign_key String, Null ✓ The signing key.
Application.wsfed_settings[].sp: Specifies service provider settings for the WSFED configuration.
dst_url String ✓ The destination URL.
entity_id String ✓ The entity ID of the service provider.
resp_bind Enumeration ✓ The response binding. Set to post.
slo_url String ✓ The single log-out URL.
token_life Integer ✓ The length of time a token is valid in seconds.
Application.wsfed_settings[].subject: Specifies subject settings for the WSFED configuration.
custom_fmt String, Null ○ The custom format of the subject.
fmt String ✓ The format for the NameID element of the subject. Either email, persistent, unspecified, or transient.
rule String, Null ○ The custom rule language for the subject.
src String ○ The source of the subject.
val String, Null ○ The value of the subject.

G2O

Encapsulates data about an Enterprise Access Application G2O credentials.

Download schema: g2o.json

Sample GET response:

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

G2O members

Member Type Required Description
G2O: Encapsulates data about an Enterprise Access Application G2O credentials.
g2o_enabled Boolean ✓ Whether G2O is enabled on an application configuration.
g2o_key String ✓ The G2O key to share with your ION configuration.
g2o_nonce String ✓ The G2O nonce to share with your ION configuration.

EdgeKey

Encapsulates data about an Enterprise Access Application Edge Key.

Download schema: edge-key.json

Sample GET response:

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

EdgeKey members

Member Type Required Description
EdgeKey: Encapsulates data about an Enterprise Access Application Edge Key.
edge_cookie_key String ✓ The edge key to share with your ION configuration.
sla_object_url String ✓ The SLA object URL to share with your ION configuration.

CommandId

Command ID for the task.

Download schema: cmdid.json

Sample POST response:

{
    "cmdid": 7883826115006123
}

CommandId members

Member Type Required Description
CommandId: Command ID for the task.
cmdid String ✓ A unique identifier for the command to track progress.

UrlLocation

Contains data and objects relating to URL locations.

Download schema: urllocation.json

Sample GET response:

{
    "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"
}

UrlLocation members

Member Type Required Description
UrlLocation: Contains data and objects relating to URL locations.
app_uuid_url String ○ A unique identifier for an application.
description String ✓ A description of the application.
name String ✓ The name of the application.
resource_uri String ○ A unique identifier for the resource location.
settings Object ○ An object containing the advanced settings of the application.
status Integer ○ The status of the application.
url String ○ A unique location for an application.
uuid_url String ○ A unique identifier for an application configuration.

AppIdp

Encapsulates configuration settings for an application identity provider (IDP).

Download schema: app-idp.json

Sample GET response:

{
    "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"
}

AppIdp members

Member Type Required Description
AppIdp: Encapsulates configuration settings for an application identity provider (IDP).
app AppIdp.app ✓ Specifies the Application associated with the application IDP.
enable_mfa String ✓ Whether multifactor authentication is enabled. Set to inherit to use the associated IDP’s setting.
idp AppIdp.idp ✓ Specifies the IDP associated with the application IDP.
resource String ✓ The type of resource.
resource_uri AppIdp.resource_uri ✓ Specifies the location of resources associated with the application IDP.
uuid_url String ✓ A unique identifier for the application IDP.
AppIdp.app: Specifies the Application associated with the application IDP.
app_uuid_url String ✓ The Application UUID URL.
name String ✓ The Application name.
AppIdp.idp: Specifies the IDP associated with the application IDP.
idp_uuid_url String ✓ The Identity Provider UUID URL.
name String ✓ The Identity Provider name.
AppIdp.resource_uri: Specifies the location of resources associated with the application IDP.
apps String ✓ The application resource URI.
href String ✓ The href resource URI.
idp String ✓ The IDP resource URI.

AppDirectory

Encapsulates configuration settings for an application directory.

Download schema: app-directory.json

Sample GET response:

{
    "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"
}

AppDirectory members

Member Type Required Description
AppDirectory: Encapsulates configuration settings for an application directory.
app AppDirectory.app ✓ Specifies the Application associated with the application directory.
directory AppDirectory.directory ✓ Specifies the directory associated with the application directory.
enable_mfa String ✓ Whether multifactor authentication is enabled. Set to inherit to use the associated IDP’s setting.
resource String ✓ The type of resource.
resource_uri AppDirectory.resource_uri ✓ Specifies the location of resources associated with the application directory.
uuid_url String ✓ A unique identifier for the application directory.
AppDirectory.app: Specifies the Application associated with the application directory.
app_uuid_url String ✓ The Application UUID URL.
name String ✓ The Application name.
AppDirectory.directory: Specifies the directory associated with the application directory.
directory_uuid_url String ✓ The directory UUID URL.
name String ✓ The directory name.
AppDirectory.resource_uri: Specifies the location of resources associated with the application directory.
apps String ✓ The application resource URI.
directories String ✓ The directory resource URI.
href String ✓ The href resource URI.

AppGroup

Encapsulates configuration settings for an application group.

Download schema: app-group.json

Sample GET response:

{
    "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"
}

AppGroup members

Member Type Required Description
AppGroup: Encapsulates configuration settings for an application group.
app AppGroup.app ✓ Specifies the Application associated with the group.
enable_mfa String ✓ Whether multifactor authentication is enabled. Set to inherit to use the associated IDP’s setting.
group AppGroup.group ✓ Specifies the associated resources of the application group.
resource String ✓ The type of resource.
resource_uri AppGroup.resource_uri ✓ Specifies the location of resources associated with the application group.
uuid_url String ✓ A unique identifier for the application group.
AppGroup.app: Specifies the Application associated with the group.
app_uuid_url String ✓ The Application UUID URL.
name String ✓ The Application name.
AppGroup.group: Specifies the associated resources of the application group.
dir_name String ✓ The directory name.
dir_uuid_url String ✓ The directory UUID URL.
group_uuid_url String ✓ The AppGroup UUID URL.
name String ✓ The IDP name.
AppGroup.resource_uri: Specifies the location of resources associated with the application group.
apps String ✓ The application resource URI.
groups String ✓ The groups resource URI.
href String ✓ The href resource URI.

Idp

Encapsulates configuration settings for an identity provider (IDP).

Download schema: idp.json

Sample GET response:

{
    "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/"
    }
}

Idp members

Member Type Required Description
Idp: Encapsulates configuration settings for an identity provider (IDP).
attribute_map String ✓ Additional attributes to include with the access_token response.
auth_request_signed Boolean ✓ Whether authorization request authentication is enabled.
auth_response_encrypt Boolean ✓ Whether authentication response encryption is enabled.
background_image String ✓ The name of the background image.
background_image_file_name String ✓ The filename of the portal background image.
client_principle_name String ✓ The principle name expected by the server in order to authenticate a client request.
company_id String ✓ The company ID.
cookie_expiry Integer ✓ The timeout value to expire session cookie in minutes.
created_at String ✓ The ISO 8601 timestamp for when the IDP configuration was created. For example, 2010-11-10T03:07:43.
default_language String ✓ The default language.
description String ✓ A description of the IDP configuration.
dns_added Boolean ✓ Whether DNS information is included with the authentication request.
enable_access_client Boolean ✓ Whether the access client is enabled.
enable_mfa Boolean ✓ Enables multifactor authentication when set to true. The default value is false.
favicon_image String ✓ The filename of the portal favicon image.
helpdesk_email String ✓ The email address for contacting helpdesk with issues.
idp_type Enumeration ✓ The type of IDP. Select 1 for Default, 2 for EAA, 3 for SAML, 4 for Okta, 5 for PingOne, 6 for OneLogin, 7 for Google, 8 for OIDC, and 9 for Azure.
iwa_keytab String ✓ A unique keytab for a service principle name (SPN) used for Integrated Windows Authentication (IWA).
lockout_interval Integer ✓ The number of minutes the user is locked out. The default value is 15.
login_cname String ✓ The login cname URL.
login_dialin_server String ✓ The URL of the login dialin server.
login_domain Integer ✓ The domain for the portal that end users access.
login_host String ✓ The service provider login host.
login_lockout String ✓ Enables a temporary lockout for multiple failed login attempts when set to on. The default value is off.
logo String ✓ The name of the portal logo.
logo_file_name String ✓ The portal logo filename.
logout_url String ✓ The single logout URL for SSO.
max_login_failures Integer ✓ The number of attempts a user is allowed before they are temporarily locked out. The default value is 5.
metadata String ✓ The Metadata of the SAML type IDP.
mfa_settings String ✓ Encapsulates multifactor authentication settings for the IDP configuration.
modified_at String ✓ The last modified ISO 8601 timestamp. For example, 2010-11-10T03:07:43.
multilang_fields String ✓ Multi language field for SAML message configuration.
name String ✓ The name of the IDP configuration.
resource_uri Idp.resource_uri ✓ Specifies the location of various IDP resources.
saml_url String ✓ The URL of the service provider SAML interface.
settings String ✓ Encapsulates login portal settings for an IDP configuration.
status Enumeration ✓ The status of the IDP configuration, either 1 for Not Ready, 2 for Ready, 3 for Pending, 4 for Deployed, 5 for Failed, 6 for Cloud Deployed, or 7 for Connector Deployed.
trust_expiry Integer ✓ The timeout value to expire the authentication request.
uuid_url String ✓ The unique UUID URL of the IDP configuration.
Idp.resource_uri: Specifies the location of various IDP resources.
directories String ✓ The directories resource URI.
groups String ✓ The groups resource URI.
href String ✓ The href resource URI.
pop String ✓ The pop resource URI.
services String ✓ The services resource URI.
sites String ✓ The sites resource URI.

Activity

Contains information about device activity.

Download schema: device-summary-roll-ups.json

Sample GET response:

[
    {
        "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
    }
]

Activity members

Member Type Required Description
Activity: Contains information about device activity.
check_in_count Integer ✓ Read-only. The total number of device check-ins.
device_count Integer ✓ Read-only. The total number of unique devices.
timestamp String ✓ Read-only. The ISO–8601 timestamp marking when the signal was obtained.

Os

Contains information about device operating systems.

Download schema: device-summary-os.json

Sample GET response:

[
    {
        "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
    }
]

Os members

Member Type Required Description
Os: Contains information about device operating systems.
custom Integer ✓ Read-only. The total number of devices with a custom operating system on a valid version set by the rules in your policy.
latest Integer ✓ Read-only. The total number of devices with the latest operating system version set by the rules in your policy.
name String ✓ Read-only. The name of the operating system.
outdated Integer ✓ Read-only. The total number of devices with an outdated operating system version set by the rules in your policy.
updated Integer ✓ Read-only. The total number of devices with an updated operating system version set by the rules in your policy.

Signal

Encapsulates information about device signals.

Download schema: device-summary-signals.json

Sample GET response:

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

Signal members

Member Type Required Description
Signal: Encapsulates information about device signals.
count Integer ✓ Read-only. The total number of devices that meet the criteria specified for this signal rule.
value String ✓ Read-only. The name of the signal rule.

History

Encapsulates information about device history.

Download schema: device-history-reports.json

Sample GET response:

{
    "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_running": true,
            "anti_malware_status": "good",
            "anti_malware_info": [
                {
                    "version": "",
                    "product_name": "Windows Defender",
                    "definitions_update": ""
                }
            ],
            "firewall_status": "poor",
            "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_running": true,
            "anti_malware_status": "good",
            "anti_malware_info": [
                {
                    "version": "",
                    "product_name": "Windows Defender",
                    "definitions_update": ""
                }
            ],
            "firewall_status": "poor",
            "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_running": true,
            "anti_malware_status": "good",
            "anti_malware_info": [
                {
                    "version": "",
                    "product_name": "Windows Defender",
                    "definitions_update": ""
                }
            ],
            "firewall_status": "poor",
            "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_running": true,
            "anti_malware_status": "good",
            "anti_malware_info": [
                {
                    "version": "",
                    "product_name": "Windows Defender",
                    "definitions_update": ""
                }
            ],
            "firewall_status": "poor",
            "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"
                }
            ]
        }
    ]
}

History members

Member Type Required Description
History: Encapsulates information about device history.
anti_malware_info History.anti_malware_info[] ○ Contains anti-malware information for a device.
anti_malware_running Boolean ○ Read-only. Whether the device’s anti-malware software is running.
anti_malware_status Enumeration ○ Read-only. The status of the anti-malware software, either poor or good.
browsers History.browsers[] ○ Contains browser details for a device.
client_version String ○ Read-only. The version of the client.
device_name String ○ Read-only. The name of the device.
firewall_status Enumeration ○ Read-only. The status of the firewall, either poor or good.
idp_username String ○ Read-only. A unique identifier for the IDP user name.
os_auto_update Boolean, Null ○ Read-only. Whether the device’s operating system automatic updates feature is enabled.
os_name String ○ Read-only. The name of the operating system.
os_update_timestamp String, Null ○ Read-only. The ISO 8601 timestamp of when the last operating system update has occurred.
os_version String ○ Read-only. The version of the Operating System.
signal_timestamp String ○ Read-only. The ISO 8601 timestamp of the latest signal received from the device.
system_disk_encryption Boolean ○ Read-only. Whether the device’s disk is encrypted.
user_id String ○ Read-only. The user associated with the device.
History.anti_malware_info[]: Contains anti-malware information for a device.
definitions_update String ○ Read-only. The ISO 8601 timestamp of the last update for the malware rules.
product_name String ○ Read-only. The name of the anti-malware software.
version String ○ Read-only. The version of the anti-malware software.
History.browsers[]: Contains browser details for a device.
name String ○ Read-only. The name of the browser.
version String ○ Read-only. The version of the browser.

AvailableOs

Encapsulates information about Operating Systems that are available to be configured in the product.

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

Sample GET response:

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

AvailableOs members

Member Type Required Description
AvailableOs: Encapsulates information about Operating Systems that are available to be configured in the product.
mobile Boolean ✓ Read-only. Indicates whether the operating system is on a mobile platform.
name String ✓ Read-only. The name of the operating system.

AvailableOsVersion

Encapsulates information about Operating System Versions that are available to be configured in the product.

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

Sample GET response:

[
    {
        "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": "Mac OS X",
        "latest": "10.15.4 (19E287)",
        "date": "2020-04-08",
        "upToDate": [
            {
                "version": "10.14.6",
                "date": "2019-09-26"
            },
            {
                "version": "10.13.6 (17G6030)",
                "date": "2019-03-29"
            },
            {
                "version": "10.12.6 (16G1918)",
                "date": "2019-03-29"
            }
        ]
    },
    {
        "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"
            }
        ]
    }
]

AvailableOsVersion members

Member Type Required Description
AvailableOsVersion: Encapsulates information about Operating System Versions that are available to be configured in the product.
latest String ✓ Read-only. The latest available version of the operating system that is supported by the product.
mobile Boolean ✓ Read-only. Indicates whether the operating system is on a mobile platform.
name String ✓ Read-only. The name of the operating system.
upToDate AvailableOsVersion.upToDate[] ✓ Read-only. Contains information on fully patched releases of all major versions supported by the operating system vendor.
AvailableOsVersion.upToDate[]: Contains information on fully patched releases of all major versions supported by the operating system vendor.
date String ✓ Read-only. The ISO 8601 date stamp indicating when the version was released.
version String ✓ Read-only. The version of the operating system.

AvailableClientVersion

Encapsulates information about available client versions that you can configure.

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

Sample GET response:

{
    "latest": "2.0.2",
    "date": "2020-04-24"
}

AvailableClientVersion members

Member Type Required Description
AvailableClientVersion: Encapsulates information about available client versions that you can configure.
latest String ✓ Read-only. The latest available version of the client that is supported by the product.

BrowserVersion

Encapsulates information about Web Browsers that are available to be configured in the product.

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

Sample GET response:

[
    {
        "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"
    }
]

BrowserVersion members

Member Type Required Description
BrowserVersion: Encapsulates information about Web Browsers that are available to be configured in the product.
date String ✓ Read-only. The ISO 8601 date stamp indicating when the version was released.
latest String ✓ Read-only. Newest major version of the web browser.
name String ✓ Read-only. The name of the web browser.

RiskAssessment

Encapsulates information about device risk assessment rules.

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

Sample GET response:

[
    {
        "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
    }
]

RiskAssessment members

Member Type Required Description
RiskAssessment: Encapsulates information about device risk assessment rules.
count Integer ✓ Read-only. The total number of devices that pass the criteria specified for this risk assessment rule.
id Integer ✓ Read-only. A unique identifier for this risk assessment rule.
name String ✓ Read-only. The name of the risk assessment rule.
tier Boolean ✓ Read-only. Whether the rule is a tier.

Browser

Encapsulates information about device activity.

Download schema: device-summary-browsers.json

Sample GET response:

[
    {
        "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
    }
]

Browser members

Member Type Required Description
Browser: Encapsulates information about device activity.
custom Integer ✓ Read-only. The total number of browsers that are running custom versions of a browser.
latest Integer ✓ Read-only. The total number of browsers running the latest version, set by the rules in your policy.
name String ✓ Read-only. The name of the browser.
outdated Integer ✓ Read-only. The total number of browsers running an outdated version set by the rules, set by the rules in your policy.

ChosenVersions

Encapsulates information about the versions selected for different dimensions of device risk assessment.

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

Sample GET response:

{
    "os": [
        {
            "name": "Android",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "name": "iOS",
            "custom": [],
            "gracePeriod": 180
        },
        {
            "name": "Mac OS X",
            "custom": [
                "10.13.6",
                "10.14.6"
            ],
            "gracePeriod": 180
        },
        {
            "name": "Windows",
            "custom": [
                "7601.24533",
                "17763.805",
                "16299.1387",
                "17763.864",
                "17134.1069",
                "7601.24535",
                "7601.24540"
            ],
            "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
        }
    ]
}

ChosenVersions members

Member Type Required Description
ChosenVersions: Encapsulates information about the versions selected for different dimensions of device risk assessment.
browsers ChosenVersions.browsers[] ✓ Contains information on the selected browser versions.
client ChosenVersions.client ✓ Contains information about the selected client versions.
os ChosenVersions.os[] ✓ Contains information about the selected OS versions.
ChosenVersions.browsers[]: Contains information on the selected browser versions.
custom Array ✓ Read-only. The version of the web browser.
gracePeriod Integer ✓ Read-only. How long the previous version is valid until it is deprecated.
name String ✓ Read-only. The name of the web browser.
ChosenVersions.client: Contains information about the selected client versions.
gracePeriod Integer ✓ Read-only. How long the previous version is valid until it is deprecated.
name String ✓ Read-only. The name of the client.
ChosenVersions.os[]: Contains information about the selected OS versions.
custom Array ✓ Read-only. The version of the operating system.
gracePeriod Integer ✓ Read-only. How long the previous version is valid until it is deprecated.
name String ✓ Read-only. The name of the operating system.

SignalName

Encapsulates information about signal definitions that are available to be configured in the product.

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

Sample GET response:

[
    {
        "name": "anti-malware",
        "type": "boolean",
        "options": [
            {
                "value": true
            }
        ],
        "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
    }
]

SignalName members

Member Type Required Description
SignalName: Encapsulates information about signal definitions that are available to be configured in the product.
mobile Boolean ✓ Read-only. Indicates whether the operating system is on a mobile platform.
name String ✓ Read-only. The name of the signal.
options SignalName.options[] ✓ Available signal value options.
type Enumeration ✓ Read-only. Signal type. Either boolean, age_lte, mselect, or select.
SignalName.options[]: Available signal value options.
name String ○ Read-only. Option name (label).
value String, Boolean ✓ Read-only. Option value.

RiskRule

Encapsulates information about configurable risk rules.

Download schema: risk-assessment-rule.json

Sample GET response:

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

RiskRule members

Member Type Required Description
RiskRule: Encapsulates information about configurable risk rules.
id Integer ✓ Read-only. A unique identifier for this risk rule.
name String ✓ Read-only. The name of the risk rule.
rank Integer ○ Read-only. The rank of the risk rule. Present only in tiers.
rules RiskRule.rules[] ✓ Available criteria rules.
version String ✓ Read-only. Risk rule schema version.
RiskRule.rules[]: Available criteria rules.
os Array ✓ Read-only. The name of the operating system.
signals RiskRule.rules[].signals[] ✓ Read-only. Available signal values.
RiskRule.rules[].signals[]: Available signal values.
name String ✓ Read-only. The name of the signal.
value Array, String, Boolean, Integer ✓ Read-only. The signal values. The response is either a single value with a type of string, integer, or boolean, or an array of similar type values.

CarbonBlack

Encapsulates information about a Carbon Black integration.

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

Sample GET response:

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

CarbonBlack members

Member Type Required Description
CarbonBlack: Encapsulates information about a Carbon Black integration.
enabled Boolean ○ Read-only. Indicates whether the Carbon Black integration is enabled.
rules CarbonBlack.rules[] ○ Contains rules for the Carbon Black integration.
CarbonBlack.rules[]: Contains rules for the Carbon Black integration.
name Enumeration ○ Read-only. The name of the integration property, either host, api-key, api-id or org-key.
value String ○ Read-only. The value of the integration property.

CrowdStrike

Encapsulates information about a CrowdStrike integration.

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

Sample GET response:

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

CrowdStrike members

Member Type Required Description
CrowdStrike: Encapsulates information about a CrowdStrike integration.
enabled Boolean ○ Read-only. Indicates whether the CrowdStrike integration is enabled.
rules CrowdStrike.rules[] ○ Contains rules for the Crowdstrike integration.
CrowdStrike.rules[]: Contains rules for the Crowdstrike integration.
name Enumeration ○ Read-only. The name of the integration property, either host, client-id, or client-secret.
value String ○ Read-only. The value of the integration property.

DeviceInventory

Encapsulates information about device inventory.

Download schema: device-summary-reports.json

Sample GET response:

{
    "meta": {
        "limit": 20,
        "offset": 20,
        "previous": "?limit=20&offset=0",
        "next": "?limit=20&offset=40",
        "total_count": 5
    },
    "objects": [
        {
            "anti_malware_info": [],
            "anti_malware_status": "poor",
            "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",
            "csi_signals": {
                "blacklisted": false
            },
            "device_id": "472d4ebbf2a9e9b05c6b1c366fb7df801d0fe59d18cf74e3a15476ba42549c6f",
            "device_name": "mac-device-1",
            "idp_username": "username@akamai.com",
            "firewall_status": "poor",
            "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": [
                {
                    "definitions_update": "",
                    "product_name": "Intego",
                    "version": ""
                }
            ],
            "anti_malware_status": "good",
            "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",
            "csi_signals": {
                "blacklisted": false
            },
            "device_id": "1c962e601cf36b2874ac1112117ccb6d179b3f5d0da7bf4d880d1a3707e0e761",
            "device_name": "mac-device-2",
            "firewall_status": "good",
            "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": [
                {
                    "definitions_update": "",
                    "product_name": "Malwarebytes",
                    "version": ""
                }
            ],
            "anti_malware_status": "good",
            "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",
            "csi_signals": {
                "blacklisted": false
            },
            "device_id": "369b5c8a97e0085f813720f7cbc9753e8b667d8112e49e656713fbaa0dbe5115",
            "device_name": "mac-device-3",
            "firewall_status": "good",
            "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": [],
            "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": false
                }
            ],
            "crowdstrike": {
                "sensor_version": "N/A",
                "last_contact": "2020-08-26T03:10:46+00:00",
                "aid": "7445e54fef9f49059c1b08c72skdhfjk",
                "cid": "b8d9a8c2c8734cf8ab68c0a9rehfuegf",
                "validity": "Valid",
                "agent_status": "Healthy"
            },
            "client_version": "0.9",
            "csi_signals": {
                "blacklisted": false
            },
            "device_biometric": true,
            "device_id": "4B1CF385-01F3-4711-96B7-3A3DD7E354F9",
            "device_jailbroken": false,
            "device_name": "iPhone",
            "device_screen_lock": true,
            "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": [],
            "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": false
                },
                {
                    "name": "Certificate Profile 3",
                    "passed": false
                }
            ],
            "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.9",
            "csi_signals": {
                "blacklisted": false
            },
            "device_biometric": true,
            "device_id": "128DCDE5-ACB0-411A-8428-5BEAAD983D0C",
            "device_jailbroken": false,
            "device_name": "iPhone",
            "device_screen_lock": true,
            "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"
        }
    ]
}

DeviceInventory members

Member Type Required Description
DeviceInventory: Encapsulates information about device inventory.
anti_malware_info DeviceInventory.anti_malware_info[] ○ Contains anti-malware information for a device.
anti_malware_status Enumeration ○ Read-only. The status of the anti-malware software, either good or poor.
browsers DeviceInventory.browsers[] ○ Contains browser information for a device.
carbon_black DeviceInventory.carbon_black ○ Read-only. Contains Carbon Black information for a device.
certificate_profile DeviceInventory.certificate_profile[] ○ Read-only. Contains the Certificate Profile status.
client_version String ○ Read-only. The version of the client.
crowdstrike DeviceInventory.crowdstrike ○ Read-only. Contains CrowdStrike information for a device.
device_biometric Boolean ○ Read-only. Whether the biometrics are enabled on the device.
device_id String ○ Read-only. A unique identifier for the device.
device_jailbroken Boolean ○ Read-only. Whether the device is running a modified or unauthorized version of the operating system.
device_name String ○ Read-only. The name of the device.
device_screen_lock Boolean ○ Read-only. Whether the device’s screen lock functionality is enabled.
etp_signals DeviceInventory.etp_signals ○ Read-only. Contains signal information from Enterprise Threat Protector (ETP).
firewall_status Enumeration ○ Read-only. The status of the firewall, either good or poor.
idp_username String ○ Read-only. A unique identifier for the IDP user name.
mobile_device Boolean ○ Read-only. Whether the device is a mobile device.
os_auto_update Boolean, Null ○ Read-only. Whether the device’s operating system Auto Update feature is enabled.
os_build String ○ Read-only. The build of the operating system version.
os_name String ○ Read-only. The name of the operating system.
os_update_timestamp String, Null ○ Read-only. The timestamp of when the last Operating System update has occurred.
os_version String ○ Read-only. The version of the operating system.
risk_posture_tags DeviceInventory.risk_posture_tags[][] ○ Encapsulates information about device risk assessment rules.
risk_posture_tiers DeviceInventory.risk_posture_tiers[][] ○ Encapsulates information about device risk assessment rules.
signal_timestamp String ○ Read-only. The timestamp of the latest signal received from the device.
system_disk_encryption Boolean ○ Read-only. Whether the device’s disk is encrypted.
user_id String ○ Read-only. The user associated with the device.
DeviceInventory.anti_malware_info[]: Contains anti-malware information for a device.
definitions_update String ○ Read-only. The date of the last update for the malware rules.
product_name String ○ Read-only. The name of the anti-malware software.
version String ○ Read-only. The version of the anti-malware software.
DeviceInventory.browsers[]: Contains browser information for a device.
name String ○ Read-only. The name of the browser.
version String ○ Read-only. The version of the browser.
DeviceInventory.carbon_black: Contains Carbon Black information for a device.
last_contact String, Null ○ Read-only. The time of the last communication of Carbon Black client installed on the device with Carbon Black server.
policy_id String ○ Read-only. Identifies the Carbon Black policy assigned to the device.
policy_name String ○ Read-only. The name of the Carbon Black policy assigned to the device.
sensor_version String ○ Read-only. The version of Carbon Black installed on the device.
status String ○ Read-only. The status of the Carbon Black client as returned by the Carbon Black server.
DeviceInventory.certificate_profile[]: Contains the Certificate Profile status.
name String ○ Read-only. The name of the Certificate Profile.
passed Boolean ○ Read-only. Status of the device for the Certificate Profile.
DeviceInventory.crowdstrike: Contains CrowdStrike information for a device.
agent_status String ○ Read-only. The health status of the Crowdstrike Falcon Sensor as assessed by the Device Posture Service.
aid String ○ Read-only. The Agent ID of the CrowdStrike Falcon Sensor which is unique to every device of that organization.
cid String ○ Read-only. The Customer ID of the CrowdStrike Falcon Sensor which is the same for all devices belonging to a particular organization.
last_contact String, Null ○ Read-only. The time of the last communication of CrowdStrike Falcon Sensor with the CrowdStrike server.
sensor_version String ○ Read-only. The version of CrowdStrike Falcon Sensor installed on the device.
validity String ○ Read-only. The validity of Agent ID and Customer ID.
DeviceInventory.etp_signals: Contains signal information from Enterprise Threat Protector (ETP).
threat_detected Boolean ○ Read-only. Whether ETP threats have been detected for the device.
DeviceInventory.risk_posture_tags[][]: Encapsulates information about device risk assessment rules.
count Integer ✓ Read-only. The total number of devices that pass the criteria specified for this risk assessment rule.
id Integer ✓ Read-only. A unique identifier for this risk assessment rule.
name String ✓ Read-only. The name of the risk assessment rule.
tier Boolean ✓ Read-only. Whether the rule is a tier.
DeviceInventory.risk_posture_tiers[][]: Encapsulates information about device risk assessment rules.
count Integer ✓ Read-only. The total number of devices that pass the criteria specified for this risk assessment rule.
id Integer ✓ Read-only. A unique identifier for this risk assessment rule.
name String ✓ Read-only. The name of the risk assessment rule.
tier Boolean ✓ Read-only. Whether the rule is a tier.

IdpDirectory

Encapsulates data about an Enterprise Access IdpDirectory.

Download schema: idpdirectory.json

Sample GET response:

{
    "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
}

IdpDirectory members

Member Type Required Description
IdpDirectory: Encapsulates data about an Enterprise Access IdpDirectory.
admin_user Null ✓ The administrator user account for the IDP directory.
agents IdpDirectory.agents[] ✓ A list of agents assigned to this IDP directory.
api_key Null ✓ The API key of the IDP directory.
attribute_map IdpDirectory.attribute_map ✓ The attribute mapping for the IDP directory.
auth_request_signed Boolean ✓ Whether the authentication request is signed.
auth_response_encrypt Boolean ✓ Whether the authentication response is encrypted.
chase_referral Boolean ✓ Whether to chase referral.
cname Null ✓ The IDP directory cname.
company_id Null ✓ The company ID of the IDP directory.
conf_state Integer ✓ The configuration state of the IDP directory.
created_at String ✓ The ISO–8601 timestamp marking when the IDP directory object was created.
description Null ✓ The ISO–8601 timestamp marking when the IDP directory object was created.
dialin_sni Null ✓ The dial-in SNI for the IDP directory.
directory_status Enumeration ✓ The status of the directory, either 1 for not added, 2 for added, 3 for no agent, 4 for pending, 5 for not reachable, or 6 for okay.
directory_type Enumeration ✓ The type of directory, either 1 for cloud, 2 for enterprise, 3 for third party, 4 for Akamai, or 5 for Akamai MSP.
domains Array ✓ The domain name.
global_catalog Boolean ✓ Whether global catalog is enabled.
group_base_dn Null ✓ The base Distinguished Name (DN) that identifies the group entry in an IDP directory. Contains a series of comma-delimited pairs formed as key=value.
group_count Integer ✓ The number of groups associated with the IDP directory.
group_members String ✓ The members of the group.
group_name String ✓ The name of the group.
group_object_classes IdpDirectory.group_object_classes[] ✓ Contains a list of group object classes defining custom LDAP mappings of users and groups.
group_search_filter String ✓ The search filter for the group.
group_token String ✓ The primary group token.
host Null ✓ The IDP directory host.
kerb_realms IdpDirectory.kerb_realms[] ✓ Contains a list of kerberos realms.
last_sync String ✓ The ISO–8601 timestamp marking of when the IDP directory was last synchronized.
logout_url Null ✓ The logout URL for the directory.
metadata Null ✓ The IDP directory metadata.
mfa Enumeration ✓ Whether multifactor authentication is enabled, either on or off.
modified_at String ✓ The ISO–8601 timestamp marking of when the directory was last modified.
name String ✓ The name of the IDP directory.
nameidformat Null ✓ The name ID format.
ou_attr Null ✓ The organizational unit’s attributes.
ou_filter Null ✓ The organizational unit filter.
ou_object_classes Array ✓ Contains a list of organization unit’s object classes.
password_change_allow Boolean ✓ Whether password change is allowed.
password_change_threshold Integer ✓ The password change threshold in seconds.
password_complexity_message Null ✓ The password complexity message.
password_expire_warn_threshold Integer ✓ The password expiration warning threshold in seconds.
password_filter Object ✓ The password filters.
password_policy_default String ✓ The default password policy for the IDP directory.
password_reset_allow Boolean ✓ Whether to allow password reset.
port Integer ✓ The port number of the IDP directory.
resource String ✓ The IDP directory resource name.
resource_uri IdpDirectory.resource_uri ✓ Specifies the location of various IDP directory resources.
root_dn Null ✓ The root distinguished name of the IDP directory. Contains a series of comma-delimited pairs formed as key=value.
schema_attributes String ✓ The directory schema attributes.
server_cert_validate Boolean ✓ Whether to validate server certificates.
service Enumeration ✓ The type of directory service, either 1 for AD, 2 for LDAP, 3 for Okta, 4 for PingOne, 5 for SAML, 6 for Cloud, 7 for OneLogin, 8 for Google, 9 for Akamai, 10 for Akamai MSP, or 11 for LDS.
signed_request Boolean ✓ Whether the request is signed.
ssl Boolean ✓ Whether SSL is enabled.
status Enumeration ✓ The directory status, either 0 for disabled or 1 for enabled.
sync_interval Integer ✓ The synchronization interval of the IDP directory in seconds.
sync_state Enumeration ✓ The IDP directory synchronization state, either 1 for dirty, 2 for agent synchronization, 3 for agent synchronization error, 4 for DPOP synchronization, 5 for DPOP synchronization error, or 6 for synchronization.
user_base_dn Null ✓ The base distinguished name of a user. Contains a series of comma-delimited pairs formed as key=value.
user_count Integer ✓ The total count of users in the IDP directory.
user_display_name String ✓ The display name of a user.
user_email String ✓ The email of a user.
user_fname String ✓ The first name of a user.
user_lname String ✓ The last name of a user.
user_memberof String ✓ The member status of a user.
user_memberuid String ✓ The member UID of a user.
user_object_classes Array ✓ The object class of a user.
user_phone_num String ✓ The phone number of a user.
user_principal String ✓ The login of a user.
user_samaccountname String ✓ The SAM account name of a user.
user_search_filter String ✓ The search filter for a user.
user_upn String ✓ The principal name of a user.
uuid_url String ○ A unique identifier for the directory.
IdpDirectory.agents[]: A list of agents assigned to this IDP directory.
name String ✓ The name of the agent.
uuid_url String ✓ A unique identifier for the agent.
IdpDirectory.attribute_map: The attribute mapping for the IDP directory.
user.countryCode String ✓ The user’s country code.
user.email String ✓ The user’s email address.
user.firstName String ✓ The user’s first name.
user.lastName String ✓ The user’s last name.
user.netbios String ✓ The user’s NetBIOS name.
user.persistentId String ✓ The user persistent ID.
user.phoneNumber String ✓ The user’s phone number.
user.samAccountName String ✓ The user’s Security Account Manager (SAM) account name.
user.userPrincipleName String ✓ The user’s principle name.
IdpDirectory.group_object_classes[]: Contains a list of group object classes defining custom LDAP mappings of users and groups.
group String ○ The groups synchronized with the IDP directory.
groupOfNames String ○ The total active directory groups.
IdpDirectory.kerb_realms[]: Contains a list of kerberos realms.
kdclist IdpDirectory.kerb_realms[].kdclist ✓ Contains a list of kerberos Key Distribution Centers (KDC).
realm String ✓ The kerberos realm.
IdpDirectory.kerb_realms[].kdclist: Contains a list of kerberos Key Distribution Centers (KDC).
ip String ✓ The IP address of the KDC.
port Integer ✓ The port number of the KDC.
IdpDirectory.resource_uri: Specifies the location of various IDP directory resources.
groups String ✓ The URL for group details.
href String ✓ The URL for IDP directory details.
users String ✓ The URL for the list of users.

Group

Encapsulates data about an Enterprise Access Application group.

Download schema: group.json

Sample GET response:

{
    "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"
}

Group members

Member Type Required Description
Group: Encapsulates data about an Enterprise Access Application group.
created_at String ✓ The ISO–8601 timestamp marking when this directory object was created, for example 2010-11-10T03:07:43.
description String ✓ A description of the group.
group_type Enumeration ✓ The type of group, either 1 for cloud, 2 for AD, 3 for OU, or 4 for LDAP Overlay.
modified_at String ✓ The ISO–8601 timestamp marking when this directory object was last modified, for example 2010-11-10T03:07:43.
name String ✓ The group name.
resource_uri Group.resource_uri ✓ Specifies the location of various group resources.
status Enumeration ✓