Set Default Organization Using PUT

• Principal User

Set default organization for principal user.

Access Policy

Role	User Accounts	Service Accounts (Client Credentials Applications)
All Roles	✔️	❌

Request

URI

PUT

https://{api_host}/csp/gateway/am/api/loggedin/user/profile/default-org

COPY

Request Body

Request body for setting default organization.

RefLinkDto of type(s) application/json

Required

{
    "refLink": "string"
}

string

refLink

Optional

Relative reference link to the resource.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Hide Details

OK

Returns RefLinkDto of type(s) application/json

"RefLinkDto Object"

string

refLink

Optional

Relative reference link to the resource.

400

Hide Details

The user is not member of the organization | Organization reference link is mandatory

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

401

Hide Details

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

Hide Details

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

404

Hide Details

The requested resource could not be found

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

409

Hide Details

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

Hide Details

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

500

Hide Details

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/csp/gateway/am/api/loggedin/user/profile/default-org
                

Deprecated

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Principal User Operations

GET

Get Loggedin User Using GET

POST

Generate User Api Token Using POST

GET

Get Loggedin User Organizations Using GET

Deprecated

GET

Get Logged In User Groups On Organization By Organization Id Using GET

GET

Get Logged In User Info Using GET

GET

Get Logged In User Roles On Organization By Organization Id Using GET

GET

Get Logged In User Service Roles On Organization By Organization Id Using GET

PUT

Set Default Organization Using PUT

Deprecated

GET

Get Loggedin User Organizations V2 Using GET