Jump to

• Request
• Response

Create Organization

post

{baseUrl}/v1/uwaas/orgs

Creates an organization in the wallet service.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• description: string
  Example: This is a test company.
• organizationName: string
  Example: Test org
• orgId: string
  Example: {{orgId}}
• status: string
  Example: ACTIVE
• tags: array tags

{
    "type":"object",
    "properties":{
        "orgId":{
            "type":"string",
            "example":"{{orgId}}"
        },
        "organizationName":{
            "type":"string",
            "example":"Test org"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string",
                "example":"seq:1"
            },
            "example":[
                "seq:1",
                "isFounder:false"
            ]
        },
        "description":{
            "type":"string",
            "example":"This is a test company."
        },
        "status":{
            "type":"string",
            "example":"ACTIVE"
        }
    },
    "example":{
        "orgId":"{{orgId}}",
        "organizationName":"Test org",
        "tags":[
            "seq:1",
            "isFounder:false"
        ],
        "description":"This is a test company.",
        "status":"ACTIVE"
    }
}

Example:

{
    "orgId":"{{orgId}}",
    "organizationName":"Test org",
    "tags":[
        "seq:1",
        "isFounder:false"
    ],
    "description":"This is a test company.",
    "status":"ACTIVE"
}

Nested Schema : tags

Type: array

Show Source

• Array of: string
  Example: seq:1

{
    "type":"array",
    "items":{
        "type":"string",
        "example":"seq:1"
    },
    "example":[
        "seq:1",
        "isFounder:false"
    ]
}

Example:

[
    "seq:1",
    "isFounder:false"
]

Security

• OAuth2Password: oauth2
  Type: oauth2

Back to Top

Response

Supported Media Types

• application/json

200 Response

Organization created successfully.

Body ()

Root Schema : UWAAS_OrganizationEnvelope

Type: object

Show Source

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

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

Nested Schema : UWAAS_OrganizationResponse

Type: object

Show Source

• createdAt: string (date-time)
• createdBy: string
• description: string
• isDeleted: boolean
• organizationName: string
• orgId: string
• status: string
• tags: array tags
• updatedAt: string (date-time)
• updatedBy: [ "string", "null" ]

{
    "type":"object",
    "properties":{
        "orgId":{
            "type":"string"
        },
        "organizationName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "tags":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "status":{
            "type":"string"
        },
        "isDeleted":{
            "type":"boolean"
        },
        "createdAt":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedAt":{
            "type":"string",
            "format":"date-time"
        },
        "updatedBy":{
            "type":[
                "string",
                "null"
            ]
        }
    }
}

Nested Schema : tags

Type: array

Show Source

• Array of: string

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

400 Response

The wrapper rejected the request before it could complete a downstream call.

Body ()

Root Schema : Wrapper_Error

Type: object

Show Source

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

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

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",
    "required":[
        "status",
        "error"
    ],
    "properties":{
        "status":{
            "type":"integer"
        },
        "error":{
            "type":"string"
        }
    }
}

Back to Top