Jump to

• Request
• Response

Add an Organization to a Channel

post

/console/admin/api/v2/channels/{channelName}/organizations

Add an organization to a channel.

Request

Supported Media Types

• application/json

Path Parameters

• channelName: string
  The specified channel name

Body ()

New organization configuration to be added. Only certificates exported from the v2 API can be used.

Root Schema : postChannelNewOrg

Type: object

Show Source

• access(optional): string
• organization(optional): object organization

{
    "type":"object",
    "properties":{
        "organization":{
            "type":"object",
            "properties":{
                "version":{
                    "type":"string"
                },
                "type":{
                    "type":"string"
                },
                "mspId":{
                    "type":"string"
                },
                "certs":{
                    "type":"object",
                    "properties":{
                        "adminCert":{
                            "type":"string"
                        },
                        "CACert":{
                            "type":"string"
                        },
                        "tlsCACert":{
                            "type":"string"
                        },
                        "rafttlsCACert":{
                            "type":"string"
                        },
                        "nodeouIdentifierCert":{
                            "type":"string"
                        },
                        "intermediateCerts":{
                            "type":"string"
                        }
                    }
                },
                "signature":{
                    "type":"string"
                }
            }
        },
        "access":{
            "type":"string"
        }
    },
    "example":{
        "organization":{
            "mspId":"Org1MSP",
            "certs":{
                "adminCert":"example",
                "CACert":"example",
                "tlsCACert":"example",
                "rafttlsCACert":"example",
                "nodeouIdentifierCert":"example",
                "intermediateCerts":"example"
            },
            "signature":"example"
        },
        "access":"ReaderWriter|ReaderOnly"
    }
}

Example:

{
    "organization":{
        "mspId":"Org1MSP",
        "certs":{
            "adminCert":"example",
            "CACert":"example",
            "tlsCACert":"example",
            "rafttlsCACert":"example",
            "nodeouIdentifierCert":"example",
            "intermediateCerts":"example"
        },
        "signature":"example"
    },
    "access":"ReaderWriter|ReaderOnly"
}

Nested Schema : organization

Type: object

Show Source

• certs(optional): object certs
• mspId(optional): string
• signature(optional): string
• type(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mspId":{
            "type":"string"
        },
        "certs":{
            "type":"object",
            "properties":{
                "adminCert":{
                    "type":"string"
                },
                "CACert":{
                    "type":"string"
                },
                "tlsCACert":{
                    "type":"string"
                },
                "rafttlsCACert":{
                    "type":"string"
                },
                "nodeouIdentifierCert":{
                    "type":"string"
                },
                "intermediateCerts":{
                    "type":"string"
                }
            }
        },
        "signature":{
            "type":"string"
        }
    }
}

Nested Schema : certs

Type: object

Show Source

• adminCert(optional): string
• CACert(optional): string
• intermediateCerts(optional): string
• nodeouIdentifierCert(optional): string
• rafttlsCACert(optional): string
• tlsCACert(optional): string

{
    "type":"object",
    "properties":{
        "adminCert":{
            "type":"string"
        },
        "CACert":{
            "type":"string"
        },
        "tlsCACert":{
            "type":"string"
        },
        "rafttlsCACert":{
            "type":"string"
        },
        "nodeouIdentifierCert":{
            "type":"string"
        },
        "intermediateCerts":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : 200successModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "status":"success"
    }
}

Example:

{
    "status":"success"
}

400 Response

Invalid arguments

Body ()

Root Schema : 400errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

Example:

{
    "respMesg":"invalid argument"
}

401 Response

Unauthorized

403 Response

Forbidden

500 Response

Internal server error

Body ()

Root Schema : 500errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Default Response

Unexpected error

Body ()

Root Schema : errorModel

Type: object

Show Source

• code: integer(int32)
• message: string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top