Org Membership

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
url	string
state	string	The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.
role	string	The user's membership type in the organization.
organization_url	string
organization	object
user	object
permissions	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/org-membership",
  "title": "Org Membership",
  "description": "Org Membership",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/orgs/octocat/memberships/defunkt"
    },
    "state": {
      "type": "string",
      "description": "The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.",
      "example": "active",
      "enum": [
        "active",
        "pending"
      ]
    },
    "role": {
      "type": "string",
      "description": "The user's membership type in the organization.",
      "example": "admin",
      "enum": [
        "admin",
        "member",
        "billing_manager"
      ]
    },
    "organization_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/orgs/octocat"
    },
    "organization": {
      "$ref": "#/components/schemas/organization-simple"
    },
    "user": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "can_create_repository": {
          "type": "boolean"
        }
      },
      "required": [
        "can_create_repository"
      ]
    }
  },
  "required": [
    "state",
    "role",
    "organization_url",
    "url",
    "organization",
    "user"
  ]
}