License Manager

mobile gateway

Download Spec

get/license-manager/api/v1/mobilegw/status

Get registration status of PrivX to Mobile Gateway

OAuth2 oauth

Required Scopes:

admin

Get registration status of PrivX to Mobile Gateway

All Scopes

admin · Admin scope - used for built-in SSH PrivX admin account
licensesManage · Clients with license manage scope
service · Microservice scope - used for communication between SSH PrivX microservices
user · Normal users

Flow Type:: authorization_code

Auth URL:: https://api.x.com/v1/auth/auth

Token URL:: https://api.x.com/v1/auth/auth

Responses

Response examples

Registration status

{
  "product_id": "product-sha256-sdHe7CJqHwCY4WePe-BgYNGF8sd6fe8ier2Buemz4xM=",
  "status": "REGISTERED",
  "used_sources": {
    "count": 1,
    "items": [
      {
        "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
        "created": "2017-01-01T15:05:05Z",
        "updated": "2017-01-01T15:05:05Z",
        "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
        "author": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
        "enabled": true,
        "ttl": 86400,
        "status_code": "OK",
        "status_text": "Connection established",
        "name": "A pretty source",
        "comment": "A comment",
        "tags": [
          "string"
        ],
        "username_pattern": [
          "string"
        ],
        "external_user_mapping": [
          {
            "source_id": "string",
            "source_search_field": "string"
          }
        ],
        "session_password_enabled": true,
        "child_session_auto_logout_delay": 900,
        "session_password_policy": {
          "password_min_length": 16,
          "password_max_length": 16,
          "use_special_characters": true,
          "use_lower_case": true,
          "use_upper_case": true,
          "use_numbers": true,
          "password_entropy": 95,
          "password_strength": "STRONG"
        },
        "connection": {
          "type": "LDAP",
          "address": "string",
          "port": 123,
          "service_address_auto_update": true,
          "iam_access_key_id": "string",
          "iam_secret_access_key": "string",
          "iam_session_token": "string",
          "iam_fetch_roles": true,
          "iam_fetch_role_path_prefix": "string",
          "google_cloud_project_ids": [
            "string"
          ],
          "google_cloud_config_json": "string",
          "openstack_version": "V2",
          "openstack_endpoint": "string",
          "openstack_username": "string",
          "openstack_user_id": "string",
          "openstack_password": "string",
          "openstack_apikey": "string",
          "openstack_domainname": "string",
          "openstack_domainid": "string",
          "openstack_token_id": "string",
          "openstack_tenant_ids": [
            "string"
          ],
          "openstack_tenant_names": [
            "string"
          ],
          "azure_base_url": "string",
          "azure_subscription_id": "string",
          "azure_tenant_id": "string",
          "azure_client_id": "string",
          "azure_client_secret": "string",
          "ldap_protocol": "LDAP",
          "ldap_base": "string",
          "ldap_user_filter": "(&(!(objectclass=computer))(objectclass=user)(!(UserAccountControl:1.2.840.113556.1.4.803:=2))) for Microsoft Active Directory",
          "ldap_bind_dn": "CN=Admin,OU=Users,OU=ad,DC=ad,DC=ordain,DC=ssh,DC=com",
          "ldap_bind_password": "FooBar",
          "ldap_user_dn_pattern": "uid={0},ou=people",
          "google_gsuite_domain": "mydomain.com, if left empty fetches all user domains",
          "google_gsuite_domain_admin_email": "admin@mydomain.com",
          "oidc_enabled": true,
          "oidc_issuer": "string",
          "oidc_button_title": "string",
          "oidc_client_id": "string",
          "oidc_client_secret": "string",
          "oidc_additional_scopes": [
            "string"
          ],
          "oidc_tags_attribute_name": "string",
          "attribute_mapping": {},
          "mfa_type": "DISABLED",
          "mfa_address": "string",
          "mfa_port": 123,
          "mfa_base_dn": "string",
          "domain_controller_fqdn": "string",
          "domain_controller_port": 123,
          "kerberos_ticket": "string",
          "enable_user_authentication": true,
          "enable_machine_authentication": true
        }
      }
    ]
  }
}

post/license-manager/api/v1/mobilegw/register

OAuth2 oauth

Required Scopes:

admin

All Scopes

admin · Admin scope - used for built-in SSH PrivX admin account
licensesManage · Clients with license manage scope
service · Microservice scope - used for communication between SSH PrivX microservices
user · Normal users

Flow Type:: authorization_code

Auth URL:: https://api.x.com/v1/auth/auth

Token URL:: https://api.x.com/v1/auth/auth

Responses

Response examples

Registration completed successfully

Empty response

post/license-manager/api/v1/mobilegw/unregister

Unregister PrivX instance from Mobile gateway. Destroys all pairing data!

OAuth2 oauth

Required Scopes:

admin

Unregister PrivX instance from Mobile gateway. Destroys all pairing data!

All Scopes

admin · Admin scope - used for built-in SSH PrivX admin account
licensesManage · Clients with license manage scope
service · Microservice scope - used for communication between SSH PrivX microservices
user · Normal users

Flow Type:: authorization_code

Auth URL:: https://api.x.com/v1/auth/auth

Token URL:: https://api.x.com/v1/auth/auth

Responses

Response examples

Unregistration completed successfully

Empty response

Was this page helpful?