Jump to

• Request
• Response

Get Organizations

get

{baseUrl}/v1/uwaas/orgs

Retrieves the organizations configured in UWaaS.

Request

Query Parameters

• chainId: string
  Optional blockchain chain identifier.
• nextPageToken: string
  Opaque cursor returned by the previous page.
• pageSize: integer
  Maximum organizations to return.

  Default Value: 50

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Organizations retrieved successfully.

Body ()

Root Schema : UWAAS_ListOrganizationsEnvelope

Type: object

Show Source

• payload(required): object UWAAS_ListOrganizationsResponse
• status(required): string

{
    "type":"object",
    "required":[
        "status",
        "payload"
    ],
    "properties":{
        "status":{
            "type":"string",
            "const":"success"
        },
        "payload":{
            "$ref":"#/components/schemas/UWAAS_ListOrganizationsResponse"
        }
    }
}

Nested Schema : UWAAS_ListOrganizationsResponse

Type: object

Show Source

• items(required): array items
• nextPageToken: [ "string", "null" ]

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/UWAAS_OrganizationResponse"
            }
        },
        "nextPageToken":{
            "type":[
                "string",
                "null"
            ]
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object UWAAS_OrganizationResponse

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/UWAAS_OrganizationResponse"
    }
}

Nested Schema : UWAAS_OrganizationResponse

Type: object

Show Source

• createdAt(required): string (date-time)
• createdBy(required): string
• description(required): string
• isDeleted(required): boolean
• organizationName(required): string
• orgId(required): string
• status(required): string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  Example: ACTIVE
• tags: array tags
• updatedAt(required): string (date-time)
• updatedBy: string

{
    "type":"object",
    "properties":{
        "orgId":{
            "type":"string"
        },
        "organizationName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "$ref":"#/components/schemas/UWAAS_OrganizationStatus"
        },
        "isDeleted":{
            "type":"boolean"
        },
        "createdAt":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedAt":{
            "type":"string",
            "format":"date-time"
        },
        "updatedBy":{
            "type":"string"
        }
    },
    "required":[
        "orgId",
        "organizationName",
        "description",
        "status",
        "isDeleted",
        "createdAt",
        "createdBy",
        "updatedAt"
    ]
}

Nested Schema : tags

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

502 Response

The wrapper could not complete the downstream call.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

• error(required): string
• status(required): integer

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    },
    "required":[
        "status",
        "error"
    ]
}

Back to Top