Jump to

• Request
• Response

Creates a new user and role mapping.

post

/learn.rest/v1/learnCenters/{learnCenterId}/userRoles/{userRoleId}/users

Request

Supported Media Types

• application/json

Path Parameters

• learnCenterId: number
  Unique identifier of a LearnCenter.
• userRoleId: number
  Unique identifier of a user role.

Body ()

User and role mapping object that needs to be created.

Root Schema : UserRolesMappingRequest

Type: object

Object containing the user identifier parameters.

Show Source

• UserId: string

{
    "type":"object",
    "description":"Object containing the user identifier parameters.",
    "required":[
        "UserId"
    ],
    "properties":{
        "UserId":{
            "type":"string"
        }
    },
    "example":{
        "UserId":"995521"
    }
}

Example:

{
    "UserId":"995521"
}

Security

• auth: basic
  Type: basic

  Description: Basic Authentication

Back to Top

Response

Supported Media Types

• application/json

201 Response

New user and role mapping created.

Body ()

Root Schema : UserRoleUserResponse

Type: object

Show Source

• createdDate(optional): string
  Example: 2019-02-04T10:46:21Z
• links(optional): array links
• roleId(optional): number
  Example: 640
• statusFlag(optional): boolean
  Example: true
• user(optional): object user
• userId(optional): number
  Example: 123123
• userRole(optional): object userRole

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"number",
            "example":123123
        },
        "roleId":{
            "type":"number",
            "example":640
        },
        "user":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserLinkItem"
                    }
                }
            }
        },
        "userRole":{
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserRoleLinkItem"
                    }
                }
            }
        },
        "createdDate":{
            "type":"string",
            "example":"2019-02-04T10:46:21Z"
        },
        "statusFlag":{
            "type":"boolean",
            "example":true
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/123/users"
                }
            ]
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    },
    "example":[
        {
            "rel":"canonical",
            "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/123/users"
        }
    ]
}

Example:

[
    {
        "rel":"canonical",
        "href":"https://{url}/learn.rest/v1/learnCenters/178409/userRoles/123/users"
    }
]

Nested Schema : user

Type: object

Show Source

• links(optional): array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItem"
            }
        }
    }
}

Nested Schema : userRole

Type: object

Show Source

• links(optional): array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserRoleLinkItem"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object UserLinkItem
  Object of the User Link Item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItem"
    }
}

Nested Schema : UserLinkItem

Type: object

Object of the User Link Item.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "description":"Object of the User Link Item.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/users/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/users/456"
}

Nested Schema : links

Type: array

Show Source

• Array of: object UserRoleLinkItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserRoleLinkItem"
    }
}

Nested Schema : UserRoleLinkItem

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"https://{url}/learn.rest/v1/learnCenters/178784/userRoles/639"
    }
}

Example:

{
    "rel":"canonical",
    "href":"https://{url}/learn.rest/v1/learnCenters/178784/userRoles/639"
}

400 Response

Request has incorrect syntax or does not contain a field that is required.

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

404 Response

Resource not found.

422 Response

Request may contain validation errors.

500 Response

Internal server error.

Back to Top