Jump to

• Request
• Response

Associate REST Client User With a Custom Enrollment

post

/console/admin/api/v1.1/nodes/restproxies/{restProxyId}/enrollments/{enrollmentId}/users

Associate a REST client user with a custom enrollment.

Request

Supported Media Types

• application/json

Path Parameters

• enrollmentId: string
  Custom enrollment ID
• restProxyId: string
  REST proxy ID

Body ()

User to be associated with custom enrollment

Root Schema : associateRestUserBody

Type: object

Show Source

• userName: string
  REST client user name

{
    "type":"object",
    "required":[
        "userName"
    ],
    "properties":{
        "userName":{
            "description":"REST client user name",
            "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