Jump to

• Request
• Response

Create Custom Enrollment for REST Proxy

post

/console/admin/api/v2/nodes/restproxies/{restProxyId}/enrollments

Create a custom enrollment for a REST proxy.

Request

Supported Media Types

• application/json

Path Parameters

• restProxyId: string
  REST proxy ID

Body ()

Create custom enrollment

Root Schema : createCustomEnrollmentBody

Type: object

Show Source

• attributes(optional): object attributes
  Additional Properties Allowed: additionalProperties

  Custom keys with string value attributes to be added to the enrollment certificate
• enrollmentId: string
  Enrollment ID

{
    "type":"object",
    "required":[
        "enrollmentId"
    ],
    "properties":{
        "enrollmentId":{
            "description":"Enrollment ID",
            "type":"string"
        },
        "attributes":{
            "description":"Custom keys with string value attributes to be added to the enrollment certificate",
            "type":"object",
            "properties":{
                "username":{
                    "description":"Special attribute to associate the default user for the enrollment",
                    "type":"string"
                }
            },
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "example":{
        "enrollmentId":"my-custom-enrollment",
        "attributes":{
            "username":"[e-mail]",
            "department":"operations",
            "role":"ADMIN"
        }
    }
}

Example:

{
    "enrollmentId":"my-custom-enrollment",
    "attributes":{
        "username":"[e-mail]",
        "department":"operations",
        "role":"ADMIN"
    }
}

Nested Schema : attributes

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Custom keys with string value attributes to be added to the enrollment certificate",
    "type":"object",
    "properties":{
        "username":{
            "description":"Special attribute to associate the default user for the enrollment",
            "type":"string"
        }
    },
    "additionalProperties":{
        "type":"string"
    }
}

Custom keys with string value attributes to be added to the enrollment certificate

Show Source

• username(optional): string
  Special attribute to associate the default user for the enrollment

{
    "description":"Custom keys with string value attributes to be added to the enrollment certificate",
    "type":"object",
    "properties":{
        "username":{
            "description":"Special attribute to associate the default user for the enrollment",
            "type":"string"
        }
    },
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: object

400 Response

Invalid arguments

Body ()

Root Schema : 400errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

Example:

{
    "respMesg":"invalid argument"
}

401 Response

Unauthorized

403 Response

Forbidden

500 Response

Internal server error

Body ()

Root Schema : 500errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Default Response

Unexpected error

Body ()

Root Schema : errorModel

Type: object

Show Source

• code: integer(int32)
• message: string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top