OPENAPI / COMPONENTS / SCHEMAS

Role data structure

Role

Structural definition for Role in the OpenAI API contract.

object7properties
descriptionstringrequired

description value in the OpenAI API contract.

idstringrequired

id value in the OpenAI API contract.

namestringrequired

name value in the OpenAI API contract.

objectstringrequired

object value in the OpenAI API contract.

permissionsarrayrequired

permissions value in the OpenAI API contract.

predefined_rolebooleanrequired

predefined role value in the OpenAI API contract.

resource_typestringrequired

resource type value in the OpenAI API contract.