Get an Organization profile

GET 
/v1/organizations/profile

Get an Organization profile

Responses

200

OK

application/json

Schema

Schema

organization

object

required

An Organization.

organizationId stringrequired

The Organization identifier.

name stringrequired

The name of the Organization.

timeZone stringrequired

An IANA time zone database identifier corresponding to the time zone for date and time related properties e.g. "Australia/Sydney".

culture stringrequired

A culture (locale) in a format "languagecode2-country/regioncode2" e.g. "en-US". The culture determines the formatting for dates and numbers.

Example (from schema)

{
  "organization": {
    "organizationId": "string",
    "name": "string",
    "timeZone": "string",
    "culture": "string"
  }
}

default

Error

application/json

Schema

Schema

code int32

An error status code describing the response.

Enum Value	Description
0	OK
1	Cancelled
2	Unknown
3	InvalidArgument
4	DeadlineExceeded
5	NotFound
6	AlreadyExists
7	PermissionDenied
8	ResourceExhausted
9	FailedPrecondition
10	Aborted
11	OutOfRange
12	Unimplemented
13	Internal
14	Unavailable
15	DataLoss
16	Unauthenticated

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

message string

A developer-facing error message

details

object[]

A list of messages containing details about the errors

Array [

@type stringrequired

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...