Jump to

• Request
• Response

Create a User Account

post

/api/user

Create a new Lobby user account. Additionally, you can create and link Aconex accounts to the new Lobby account.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• aconexUsers: array aconexUsers
  The fields required to create an Aconex user account.
• lobbyUser: object CreateLobbyUserRequest
  The fields required to create a Lobby user account.

{
    "type":"object",
    "properties":{
        "lobbyUser":{
            "$ref":"#/components/schemas/CreateLobbyUserRequest"
        },
        "aconexUsers":{
            "type":"array",
            "description":"The fields required to create an Aconex user account.",
            "format":"array",
            "items":{
                "$ref":"#/components/schemas/CreateAconexUserRequest"
            }
        }
    }
}

Nested Schema : aconexUsers

Type: array

The fields required to create an Aconex user account.

Show Source

• Array of: object CreateAconexUserRequest
  The fields required to create an Aconex user account.

{
    "type":"array",
    "description":"The fields required to create an Aconex user account.",
    "format":"array",
    "items":{
        "$ref":"#/components/schemas/CreateAconexUserRequest"
    }
}

Nested Schema : CreateLobbyUserRequest

Type: object

The fields required to create a Lobby user account.

Show Source

• emailAddress(required): string (String)
  The email address for the Lobby and Aconex user. This will also server as the Lobby username.
• firstName(required): string (String)
  The first name for the new Lobby user.
• language(required): string (String)
  The language to use when sending emails from Lobby and Aconex.
• lastName(required): string (String)
  The last name for the new Lobby user.
• lobbyOrganizationId(required): integer (int64)
  The organization id where the Lobby user will be created. Known as the user's Home Organization.
• middleName: string (String)
  The middle name for the new Lobby user.
• setPassword(required): boolean (boolean)
  Determines if the new Lobby user should get an email to set a password. True to send an email. False to not send an email.

{
    "required":[
        "emailAddress",
        "firstName",
        "language",
        "lastName",
        "lobbyOrganizationId",
        "setPassword"
    ],
    "type":"object",
    "properties":{
        "emailAddress":{
            "type":"string",
            "description":"The email address for the Lobby and Aconex user.  This will also server as the Lobby username.",
            "format":"String"
        },
        "firstName":{
            "type":"string",
            "description":"The first name for the new Lobby user.",
            "format":"String"
        },
        "middleName":{
            "type":"string",
            "description":"The middle name for the new Lobby user. ",
            "format":"String"
        },
        "lastName":{
            "type":"string",
            "description":"The last name for the new Lobby user. ",
            "format":"String"
        },
        "language":{
            "type":"string",
            "description":"The language to use when sending emails from Lobby and Aconex.",
            "format":"String"
        },
        "lobbyOrganizationId":{
            "type":"integer",
            "description":"The organization id where the Lobby user will be created.  Known as the user's Home Organization.",
            "format":"int64"
        },
        "setPassword":{
            "type":"boolean",
            "description":"Determines if the new Lobby user should get an email to set a password. True to send an email. False to not send an email.",
            "format":"boolean"
        }
    },
    "description":"The fields required to create a Lobby user account."
}

Nested Schema : CreateAconexUserRequest

Type: object

The fields required to create an Aconex user account.

Show Source

• aconexOrganizationId(required): integer (int64)
  The Aconex organization id where the new user needs to be created.
• appInstanceId(required): integer (int64)
  The Lobby application instance id where the Aconex user will be created.
• projectIds: array projectIds
  The list of Aconex project ids that the new Aconex user should be invited to.

{
    "required":[
        "aconexOrganizationId",
        "appInstanceId"
    ],
    "type":"object",
    "properties":{
        "appInstanceId":{
            "type":"integer",
            "description":"The  Lobby application instance id where the Aconex user will be created.",
            "format":"int64"
        },
        "aconexOrganizationId":{
            "type":"integer",
            "description":"The Aconex organization id where the new user needs to be created.",
            "format":"int64"
        },
        "projectIds":{
            "type":"array",
            "description":"The list of Aconex project ids that the new Aconex user should be invited to.",
            "format":"Array",
            "items":{
                "type":"string",
                "description":"The list of Aconex project ids that the new Aconex user should be invited to.",
                "format":"Array"
            }
        }
    },
    "description":"The fields required to create an Aconex user account.",
    "format":"array"
}

Nested Schema : projectIds

Type: array

The list of Aconex project ids that the new Aconex user should be invited to.

Show Source

• Array of: string(Array)
  The list of Aconex project ids that the new Aconex user should be invited to.

{
    "type":"array",
    "description":"The list of Aconex project ids that the new Aconex user should be invited to.",
    "format":"Array",
    "items":{
        "type":"string",
        "description":"The list of Aconex project ids that the new Aconex user should be invited to.",
        "format":"Array"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : CreateUserResponse

Type: object

Show Source

• aconexUser: array aconexUser
  The fields for the newly created Aconex user account.
• lobbyUser: object CreateLobbyUserResponse
  The fields for the newly created Lobby user account.

{
    "type":"object",
    "properties":{
        "lobbyUser":{
            "$ref":"#/components/schemas/CreateLobbyUserResponse"
        },
        "aconexUser":{
            "type":"array",
            "description":"The fields for the newly created Aconex user account.",
            "items":{
                "$ref":"#/components/schemas/CreateAconexUserResponse"
            }
        }
    }
}

Nested Schema : aconexUser

Type: array

The fields for the newly created Aconex user account.

Show Source

• Array of: object CreateAconexUserResponse
  The fields for the newly created Aconex user account.

{
    "type":"array",
    "description":"The fields for the newly created Aconex user account.",
    "items":{
        "$ref":"#/components/schemas/CreateAconexUserResponse"
    }
}

Nested Schema : CreateLobbyUserResponse

Type: object

The fields for the newly created Lobby user account.

Show Source

• displayName: string (String)
  The first, middle, and last name for the newly created Lobby user account.
• emailAddress: string (String)
  The email address for the newly created Lobby user account. This is also the Lobby username.
• firstName: string (String)
  The first name for the newly created Lobby user account.
• lastName: string (String)
  The last name for the newly created Lobby user account.
• middleName: string (String)
  The middle name for the newly created Lobby user account.
• organizationId: integer (int64)
  The Lobby organization where the newly created Lobby user account exists. Known as the user's Home Organization.

{
    "type":"object",
    "properties":{
        "firstName":{
            "type":"string",
            "description":"The first name for the newly created Lobby user account.",
            "format":"String"
        },
        "middleName":{
            "type":"string",
            "description":"The middle name for the newly created Lobby user account.",
            "format":"String"
        },
        "lastName":{
            "type":"string",
            "description":"The last name for the newly created Lobby user account.",
            "format":"String"
        },
        "emailAddress":{
            "type":"string",
            "description":"The email address for the newly created Lobby user account. This is also the Lobby username.",
            "format":"String"
        },
        "displayName":{
            "type":"string",
            "description":"The first, middle, and last name for the newly created Lobby user account.",
            "format":"String"
        },
        "organizationId":{
            "type":"integer",
            "description":"The Lobby organization where the newly created Lobby user account exists. Known as the user's Home Organization.",
            "format":"int64"
        }
    },
    "description":"The fields for the newly created Lobby user account."
}

Nested Schema : CreateAconexUserResponse

Type: object

The fields for the newly created Aconex user account.

Show Source

• accountLinked: boolean (boolean)
  Denotes if the Aconex account was linked to the Lobby account.
• aconexOrganizationId: integer (int64)
  The organization id of the Aconex organization.
• appInstanceId: integer (int64)
  The application instance where the linked Aconex account resides.
• errorDescription: string (string)
  Will display any issues that occurred during the user creation process.
• hasLinkedAccounts: boolean (boolean)
  Denotes if there are any linked accounts from the organization for the requested user.
• location: string (String)
  The city, state, and country of the lobby organization.
• projectId: array projectId
  The list of Aconex projects each new aconex user account is invited to.
• region: string (String)
  The name of the region the application instance belongs.
• userId: string (string)
  The unique identifier for the Aconex user account.
• userName: string (string)
  The username for the newly create Aconex user account.

{
    "type":"object",
    "properties":{
        "accountLinked":{
            "type":"boolean",
            "description":"Denotes if the Aconex account was linked to the Lobby account.",
            "format":"boolean"
        },
        "appInstanceId":{
            "type":"integer",
            "description":"The application instance where the linked Aconex account resides.",
            "format":"int64"
        },
        "aconexOrganizationId":{
            "type":"integer",
            "description":"The organization id of the Aconex organization.",
            "format":"int64"
        },
        "userId":{
            "type":"string",
            "description":"The unique identifier for the Aconex user account.",
            "format":"string"
        },
        "userName":{
            "type":"string",
            "description":"The username for the newly create Aconex user account.",
            "format":"string"
        },
        "location":{
            "type":"string",
            "description":"The city, state, and country of the lobby organization.",
            "format":"String"
        },
        "region":{
            "type":"string",
            "description":"The name of the region the application instance belongs.",
            "format":"String"
        },
        "projectId":{
            "type":"array",
            "description":"The list of Aconex projects each new aconex user account is invited to.",
            "format":"Array",
            "items":{
                "type":"string",
                "description":"The list of Aconex projects each new aconex user account is invited to.",
                "format":"Array"
            }
        },
        "errorDescription":{
            "type":"string",
            "description":"Will display any issues that occurred during the user creation process.",
            "format":"string"
        },
        "hasLinkedAccounts":{
            "type":"boolean",
            "description":"Denotes if there are any linked accounts from the organization for the requested user.",
            "format":"boolean"
        }
    },
    "description":"The fields for the newly created Aconex user account."
}

Nested Schema : projectId

Type: array

The list of Aconex projects each new aconex user account is invited to.

Show Source

• Array of: string(Array)
  The list of Aconex projects each new aconex user account is invited to.

{
    "type":"array",
    "description":"The list of Aconex projects each new aconex user account is invited to.",
    "format":"Array",
    "items":{
        "type":"string",
        "description":"The list of Aconex projects each new aconex user account is invited to.",
        "format":"Array"
    }
}

400 Response

One or more required fields are missing.

401 Response

You do not have privileges to perform this action.

500 Response

Unable to create user account.

Back to Top