Get a TLS service profile

GET 
/tls-service-profiles/:id

Get an existing TLS service profile.

Request

Path Parameters

id uuidrequired

The UUID of the configuration resource

Responses

200

OK

application/json

Schema

Schema

oneOf

folder

folder stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The folder in which the resource is defined

snippet

snippet stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The snippet in which the resource is defined

device

device stringrequired

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

The device in which the resource is defined

id stringrequired

The UUID of the TLS service profile

name stringrequired

Possible values: <= 127 characters, Value must match regular expression ^[a-zA-Z0-9._-]+$

TLS service profile name. The value is muCustomDomainSSLProfile when it is used on mobile-agent infra settings.

certificate stringrequired

Possible values: <= 255 characters

Certificate name

protocol_settings objectrequired

Protocol settings

min_version

Possible values: [tls1-0, tls1-1, tls1-2]

Default value: tls1-2

Minimum TLS version

max_version

Possible values: [tls1-0, tls1-1, tls1-2, tls1-3]

Default value: tls1-3

Maximum TLS version

keyxchg_algo_rsa boolean

Allow RSA algorithm?

keyxchg_algo_dhe boolean

Allow DHE algorithm?

keyxchg_algo_ecdhe boolean

Allow ECDHE algorithm?

enc_algo_3des boolean

Allow 3DES algorithm?

enc_algo_rc4 boolean

Allow RC4 algorithm?

enc_algo_aes_128_cbc boolean

Allow AES-128-CBC algorithm?

enc_algo_aes_256_cbc boolean

Allow AES-256-CBC algorithm?

enc_algo_aes_128_gcm boolean

Allow AES-128-GCM algorithm?

enc_algo_aes_256_gcm boolean

Allow algorithm AES-256-GCM

auth_algo_sha1 boolean

Allow SHA1 authentication?

auth_algo_sha256 boolean

Allow SHA256 authentication?

auth_algo_sha384 boolean

Allow SHA384 authentication?

Example (from schema)

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "name": "string",
  "certificate": "string",
  "protocol_settings": {
    "keyxchg_algo_rsa": true,
    "keyxchg_algo_dhe": true,
    "keyxchg_algo_ecdhe": true,
    "enc_algo_3des": true,
    "enc_algo_rc4": true,
    "enc_algo_aes_128_cbc": true,
    "enc_algo_aes_256_cbc": true,
    "enc_algo_aes_128_gcm": true,
    "enc_algo_aes_256_gcm": true,
    "auth_algo_sha1": true,
    "auth_algo_sha256": true,
    "auth_algo_sha384": true
  }
}

400

Bad Request

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

input_format_mismatch

Input Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Input Format Mismatch: input-format=json",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

output_format_mismatch

Output Format Mismatch

{
  "_errors": [
    {
      "code": "E003",
      "message": "Output Format Mismatch: output-format=json Accept=xml",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

missing_query_parameter

Missing Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Missing Query Parameter: name",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_query_parameter

Invalid Query Parameter

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Query Parameter: location=invalid",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

401

Unauthorized

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_not_authenticated

Not Authenticated

{
  "_errors": [
    {
      "code": "E016",
      "message": "Not Authenticated",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_credential

Invalid Credential

{
  "_errors": [
    {
      "code": "E016",
      "message": "Invalid Credential",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_too_long

Key Too Long

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Too Long",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

key_expired

Key Expired

{
  "_errors": [
    {
      "code": "E016",
      "message": "Key Expired",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

need_password_change

Need Password Change

{
  "_errors": [
    {
      "code": "E016",
      "message": "The password needs to be changed.",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

403

Forbidden

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

auth_unauthorized

Unauthorized

{
  "_errors": [
    {
      "code": "E007",
      "message": "Unauthorized",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

404

Not Found

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

object_not_present

Object Not Present

{
  "_errors": [
    {
      "code": "E005",
      "message": "Object Not Present",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

default

General Errors

application/json

Schema

Schema

_errors object[]
Array [
code string
message string
details object
help string
]
_request_id string

Example (from schema)

{
  "_errors": [
    {
      "code": "string",
      "message": "string",
      "details": {},
      "help": "string"
    }
  ],
  "_request_id": "string"
}

version_not_supported

Version Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Version Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

method_not_allowed

Method Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Method Not Supported",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

action_not_supported

Action Not Supported

{
  "_errors": [
    {
      "code": "E012",
      "message": "Action Not Supported: move",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

bad_xpath

Bad XPath

{
  "_errors": [
    {
      "code": "E013",
      "message": "Bad XPath",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

invalid_command

Invalid Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Invalid Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

malformed_command

Malformed Command

{
  "_errors": [
    {
      "code": "E003",
      "message": "Malformed Command",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

session_timeout

Session Timeout

{
  "_errors": [
    {
      "code": "4",
      "message": "Session Timeout",
      "details": {}
    }
  ],
  "_request_id": "123e4567-e89b-12d3-a456-426655440000"
}

Loading...