Get Organization Branding Using GET

Get branding in organization.

Access Policy

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

Request

URI

GET

https://{api_host}/csp/gateway/branding/api/orgs/{orgId}

COPY

Path Parameters

string

orgId

Required

Organization ID

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns OrganizationBrandingDto of type(s) application/json

{
    "organizationHeaderBranding": {
        "logoLight": "string",
        "name": "string",
        "logoDark": "string",
        "backgroundColorLight": "string",
        "backgroundColorDark": "string",
        "textColorLight": "string",
        "organizationId": "string",
        "sameLogoAsLight": false,
        "serviceHeaderDisplayName": "string",
        "textColorDark": "string"
    }
}

object

organizationHeaderBranding

Optional

Organization Header Branding

204

Branding for this organization not found

Returns OrganizationBrandingDto of type(s) application/json

"OrganizationBrandingDto Object"

object

organizationHeaderBranding

Optional

Organization Header Branding

401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

404

Organization not found

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

message

Optional

message

string

errorCode

Optional

errorCode

string

requestId

Optional

requestId

integer As int32 As int32

moduleCode

Optional

moduleCode

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/branding/api/orgs/{orgId}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

204 Response Body

Errors

Organization Branding Operations

PATCH

Patch Organization Branding Using PATCH

POST

Create Organization Branding Using POST

DELETE

Delete Organization Branding Using DELETE

GET

Get Organization Branding Using GET