Jump to

• Request
• Response

Create an Admin User for an Organization

post

/api/v2/organizations/{id}/admins/

Make a POST request to this resource with the following admin user fields to create a new admin user associated with this organization.

• username: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)
• first_name: (string, default="")
• last_name: (string, default="")
• email: (string, default="")
• is_superuser: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False)
• is_system_auditor: (boolean, default=False)
• password: Field used to change the password. (string, default="")

Add Admin Users for an Organization:

Make a POST request to this resource with only an id field to associate an existing admin user with this organization.

Remove Admin Users from this Organization:

Make a POST request to this resource with id and disassociate fields to remove the admin user from this organization without deleting the admin user.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Body ()

Root Schema : User

Type: object

Show Source

• created: string
  Title: Created

  Read Only: true
• email: string
  Title: Email address

  Maximum Length: 254
• external_account: string
  Title: External account

  Read Only: true

  Set if the account is managed by an external service
• first_name: string
  Title: First name

  Maximum Length: 150
• id: integer
  Title: ID

  Read Only: true
• is_superuser: boolean
  Title: Superuser status

  Designates that this user has all permissions without explicitly assigning them.
• is_system_auditor: boolean
  Title: Is system auditor
• last_login: string(date-time)
  Title: Last login

  Read Only: true
• last_name: string
  Title: Last name

  Maximum Length: 150
• ldap_dn: string
  Title: Ldap dn

  Read Only: true

  Minimum Length: 1
• modified: string
  Title: Modified

  Read Only: true
• password: string
  Title: Password

  Minimum Length: 1

  Field used to change the password.
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true
• username(required): string
  Title: Username

  Minimum Length: 1

  Maximum Length: 150

  Pattern: ^[\w.@+-]+$

  Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "email":{
            "maxLength":"254",
            "title":"Email address",
            "type":"string",
            "x-nullable":true
        },
        "external_account":{
            "description":"Set if the account is managed by an external service",
            "readOnly":true,
            "title":"External account",
            "type":"string"
        },
        "first_name":{
            "maxLength":"150",
            "title":"First name",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "is_superuser":{
            "description":"Designates that this user has all permissions without explicitly assigning them.",
            "title":"Superuser status",
            "type":"boolean",
            "x-nullable":true
        },
        "is_system_auditor":{
            "title":"Is system auditor",
            "type":"boolean"
        },
        "last_login":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last login",
            "type":"string",
            "x-nullable":true
        },
        "last_name":{
            "maxLength":"150",
            "title":"Last name",
            "type":"string",
            "x-nullable":true
        },
        "ldap_dn":{
            "minLength":"1",
            "readOnly":true,
            "title":"Ldap dn",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "password":{
            "description":"Field used to change the password.",
            "minLength":"1",
            "title":"Password",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "username":{
            "description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "maxLength":"150",
            "minLength":"1",
            "pattern":"^[\\w.@+-]+$",
            "title":"Username",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "username"
    ],
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Body ()

Root Schema : User

Type: object

Show Source

• created: string
  Title: Created

  Read Only: true
• email: string
  Title: Email address

  Maximum Length: 254
• external_account: string
  Title: External account

  Read Only: true

  Set if the account is managed by an external service
• first_name: string
  Title: First name

  Maximum Length: 150
• id: integer
  Title: ID

  Read Only: true
• is_superuser: boolean
  Title: Superuser status

  Designates that this user has all permissions without explicitly assigning them.
• is_system_auditor: boolean
  Title: Is system auditor
• last_login: string(date-time)
  Title: Last login

  Read Only: true
• last_name: string
  Title: Last name

  Maximum Length: 150
• ldap_dn: string
  Title: Ldap dn

  Read Only: true

  Minimum Length: 1
• modified: string
  Title: Modified

  Read Only: true
• password: string
  Title: Password

  Minimum Length: 1

  Field used to change the password.
• related: string
  Title: Related

  Read Only: true
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true
• username(required): string
  Title: Username

  Minimum Length: 1

  Maximum Length: 150

  Pattern: ^[\w.@+-]+$

  Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "email":{
            "maxLength":"254",
            "title":"Email address",
            "type":"string",
            "x-nullable":true
        },
        "external_account":{
            "description":"Set if the account is managed by an external service",
            "readOnly":true,
            "title":"External account",
            "type":"string"
        },
        "first_name":{
            "maxLength":"150",
            "title":"First name",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "is_superuser":{
            "description":"Designates that this user has all permissions without explicitly assigning them.",
            "title":"Superuser status",
            "type":"boolean",
            "x-nullable":true
        },
        "is_system_auditor":{
            "title":"Is system auditor",
            "type":"boolean"
        },
        "last_login":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last login",
            "type":"string",
            "x-nullable":true
        },
        "last_name":{
            "maxLength":"150",
            "title":"Last name",
            "type":"string",
            "x-nullable":true
        },
        "ldap_dn":{
            "minLength":"1",
            "readOnly":true,
            "title":"Ldap dn",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "password":{
            "description":"Field used to change the password.",
            "minLength":"1",
            "title":"Password",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "username":{
            "description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.",
            "maxLength":"150",
            "minLength":"1",
            "pattern":"^[\\w.@+-]+$",
            "title":"Username",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "username"
    ],
    "type":"object"
}

Back to Top