Jump to

• Request
• Response

Update Policies of a Channel

post

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

Update the policies of a channel.

Request

Supported Media Types

• application/json

Path Parameters

• channelName: string
  The specified channel name

Body ()

The new policies

Root Schema : schema

Type: object

Show Source

• policies(optional): object policies

{
    "type":"object",
    "properties":{
        "policies":{
            "type":"object",
            "properties":{
                "readers":{
                    "type":"object",
                    "properties":{
                        "mspIds":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    }
                },
                "writers":{
                    "type":"object",
                    "properties":{
                        "mspIds":{
                            "type":"array",
                            "items":{
                                "type":"string"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : policies

Type: object

Show Source

• readers(optional): object readers
• writers(optional): object writers

{
    "type":"object",
    "properties":{
        "readers":{
            "type":"object",
            "properties":{
                "mspIds":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "writers":{
            "type":"object",
            "properties":{
                "mspIds":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : readers

Type: object

Show Source

• mspIds(optional): array mspIds

{
    "type":"object",
    "properties":{
        "mspIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : writers

Type: object

Show Source

• mspIds(optional): array mspIds

{
    "type":"object",
    "properties":{
        "mspIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : mspIds

Type: array

Show Source

• Array of: string

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

Nested Schema : mspIds

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "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

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Resource not found

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"
        }
    }
}

Back to Top