Cloud-Plugins Admin Rest API (1.6.3)

Download OpenAPI specification:Download

Cloud-Plugins Admin Rest API

Authentication

basicAuth

Security scheme type: HTTP
HTTP Authorization Scheme basic

Retrieving user data

Retrieve user data using different request methods

get custom name of user

get /contexts/{contextid}/users/{userid}/custom
http://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom
https://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom

get custom name of user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist or custom id not found in user

Response samples

application/json
Copy
Expand all Collapse all
{
  • "custom":
    [
    ]
}

get msisdn of user

get /contexts/{contextid}/users/{userid}/msisdn
http://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn
https://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn

get msisdn of user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist or msisdn not set for user

Response samples

application/json
Copy
Expand all Collapse all
{
  • "msisdn": "+49.12345.6789"
}

get uidname of user

get /contexts/{contextid}/users/{userid}/uidname
http://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uidname
https://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uidname

get uidname of user

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Success

401

Authorization error

404

User does not exist

Response samples

application/json
Copy
Expand all Collapse all
{
  • "uidname": "johndoe@example.com"
}

search for users using given query parameters

get /oxuser
http://example.com/services/oxaas/v1/admin/oxuser
https://example.com/services/oxaas/v1/admin/oxuser

get uidname of user

Authorizations:
query Parameters
search
required
string

string to search for

field
string
Enum:"UIDNAME" "MSISDN" "CUSTOM" "ANY"

field to search into

Responses

200

Success

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User not found

Response samples

application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "msisdn": "+49.12345.6789",
  • "uidname": "johndoe@example.com",
  • "user-id": 42
}

Modifying users

User modification methods

delete custom id(s)

delete /contexts/{contextid}/users/{userid}/custom
http://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom
https://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Settings successfully updated

401

Authorization error

404

User does not exist

Response samples

application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "msisdn": "+49.12345.6789",
  • "uidname": "johndoe@example.com",
  • "user-id": 42
}

change custom id(s)

put /contexts/{contextid}/users/{userid}/custom
http://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom
https://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/custom

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json
custom
string

Responses

200

Settings successfully updated

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

Request samples

application/json
Copy
Expand all Collapse all
{
  • "custom": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "msisdn": "+49.12345.6789",
  • "uidname": "johndoe@example.com",
  • "user-id": 42
}

delete msisdn

delete /contexts/{contextid}/users/{userid}/msisdn
http://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn
https://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Responses

200

Settings successfully updated

401

Authorization error

404

User does not exist

Response samples

application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "msisdn": "+49.12345.6789",
  • "uidname": "johndoe@example.com",
  • "user-id": 42
}

change msisdn

put /contexts/{contextid}/users/{userid}/msisdn
http://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn
https://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/msisdn

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json
msisdn
string

Responses

200

Settings successfully updated

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

Request samples

application/json
Copy
Expand all Collapse all
{
  • "msisdn": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "msisdn": "+49.12345.6789",
  • "uidname": "johndoe@example.com",
  • "user-id": 42
}

change uidname

put /contexts/{contextid}/users/{userid}/uidname
http://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uidname
https://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uidname

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json
uidname
string

Responses

200

Settings successfully updated

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

409

User does already exist

Request samples

application/json
Copy
Expand all Collapse all
{
  • "uidname": "string"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "msisdn": "+49.12345.6789",
  • "uidname": "johndoe@example.com",
  • "user-id": 42
}

change or remove msisdn or custom id(s)

post /contexts/{contextid}/users/{userid}/uids
http://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uids
https://example.com/services/oxaas/v1/admin/contexts/{contextid}/users/{userid}/uids

change user data

Authorizations:
path Parameters
contextid
required
number

context id

userid
required
number

user id

Request Body schema: application/json
custom
Array of string
msisdn
string

Responses

200

Settings successfully updated

201

At least one setting has been created

400

Generic error, e.g. wrong parameters

401

Authorization error

404

User does not exist

Request samples

application/json
Copy
Expand all Collapse all
{
  • "custom":
    [
    ],
  • "msisdn": "+49.12345.6789"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "context-id": 24,
  • "msisdn": "+49.12345.6789",
  • "uidname": "johndoe@example.com",
  • "user-id": 42
}