Users

Get All Users

get

/v3/users

Returns all the users of the organization. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/users

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Users.GetAll(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": [
    {
      "id": "text",
      "first_name": "text",
      "last_name": "text",
      "username_for_display": "text",
      "email": "text",
      "contact": {
        "dial_code": "text",
        "phone_number": "text"
      },
      "secondary_emails": [
        "text"
      ],
      "email_verified": true,
      "time_zone": "text",
      "title": "text",
      "bio": "text",
      "notification_rules": [
        {
          "type": "text",
          "time": 1
        }
      ],
      "user_image": true,
      "role_id": "text",
      "role": "text"
    }
  ]
}

Add User

post

/v3/users

Add user to the organization with given role if not exists. Returns the user object in response. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

emailstringRequired

rolestring · enumRequiredPossible values:

first_namestringRequired

last_namestringRequired

Responses

201

The request has succeeded and a new resource has been created as a result.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

post

/v3/users

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Users.Add(ctx, components.V3UsersAddUserRequest{
        Email: "[email protected]",
        Role: components.V3UsersAddUserRequestRoleAccountOwner,
        FirstName: "Yvonne",
        LastName: "Kozey",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "first_name": "text",
    "last_name": "text",
    "username_for_display": "text",
    "email": "text",
    "contact": {
      "dial_code": "text",
      "phone_number": "text"
    },
    "secondary_emails": [
      "text"
    ],
    "email_verified": true,
    "time_zone": "text",
    "title": "text",
    "bio": "text",
    "notification_rules": [
      {
        "type": "text",
        "time": 1
      }
    ],
    "user_image": true,
    "role_id": "text",
    "role": "text"
  }
}

Update Org Level Permissions

put

/v3/users/abilities

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

The request has succeeded.

application/json

datastringRequired

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put

/v3/users/abilities

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Users.UpdateOrgLevelPermissions(ctx, components.V3UsersUpdateUserAbilitiesRequest{
        Data: []components.V3UsersUpdateUserAbilitiesRequestData{},
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": "text"
}

Delete User

put

/v3/users/delete-user

This API replaces the swap_user for all the entities in Squadcast with user_id provided and deletes the user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

user_idstringRequired

swap_user_idstringRequired

suppress_incidentsbooleanRequired

reassign_incidentsbooleanRequired

Responses

200

The request has succeeded.

application/json

dataobjectRequired

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put

/v3/users/delete-user

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Users.Delete(ctx, operations.UsersDeleteUserRequest{
        UserID: "<id>",
        SwapUserID: "<id>",
        SuppressIncidents: true,
        ReassignIncidents: true,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {}
}

Get User Roles

get

/v3/users/roles

Returns all available user roles. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/users/roles

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Users.GetRoles(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "limit": 1,
      "order": 1
    }
  ]
}

Get User By ID

get

/v3/users/{userID}

Returns a users details of the given userID in the request param. Requires access_token as a Bearer {{token}} in the Authorization header with read scope.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIDstringRequired

(Required) user id

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

get

/v3/users/{userID}

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Users.GetByID(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "first_name": "text",
    "last_name": "text",
    "username_for_display": "text",
    "email": "text",
    "contact": {
      "dial_code": "text",
      "phone_number": "text"
    },
    "secondary_emails": [
      "text"
    ],
    "email_verified": true,
    "time_zone": "text",
    "title": "text",
    "bio": "text",
    "notification_rules": [
      {
        "type": "text",
        "time": 1
      }
    ],
    "user_image": true,
    "role_id": "text",
    "role": "text"
  }
}

Update User by userID

put

/v3/users/{userID}

Update User by userID. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIDstringRequired

(Required) user id

Body

rolestring · enumRequiredPossible values:

Responses

200

The request has succeeded.

application/json

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

put

/v3/users/{userID}

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"github.com/SquadcastHub/squadcast-sdk-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Users.Update(ctx, "<id>", components.V3UsersUpdateUserRequest{
        Role: components.V3UsersUpdateUserRequestRoleUser,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

{
  "data": {
    "id": "text",
    "first_name": "text",
    "last_name": "text",
    "username_for_display": "text",
    "email": "text",
    "contact": {
      "dial_code": "text",
      "phone_number": "text"
    },
    "secondary_emails": [
      "text"
    ],
    "email_verified": true,
    "time_zone": "text",
    "title": "text",
    "bio": "text",
    "notification_rules": [
      {
        "type": "text",
        "time": 1
      }
    ],
    "user_image": true,
    "role_id": "text",
    "role": "text"
  }
}

Remove User From Org

delete

/v3/users/{userID}

Remove user from organization. Upon sccess the user will be removed from the organization. Requires access_token as a Bearer {{token}} in the Authorization header with user-write scope.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

userIDstringRequired

(Required) user id

Responses

204

There is no content to send for this request, but the headers may be useful.

*/*

400

The server could not understand the request due to invalid syntax.

application/json

401

Access is unauthorized.

application/json

402

Client error

application/json

403

Access is forbidden.

application/json

404

The server cannot find the requested resource.

application/json

409

The request conflicts with the current state of the server.

application/json

422

Client error

application/json

500

Server error

application/json

502

Server error

application/json

503

Service unavailable.

application/json

504

Server error

application/json

delete

/v3/users/{userID}

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/SquadcastHub/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_BEARER_AUTH")),
    )

    res, err := s.Users.RemoveFromOrg(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Body != nil {
        // handle response
    }
}

{}

PreviousUsers/Api Token NextWebforms

Last updated 3 days ago

Good morning

hashtagGet All Users

hashtagAdd User

hashtagUpdate Org Level Permissions

hashtagDelete User

hashtagGet User Roles

hashtagGet User By ID

hashtagUpdate User by userID

hashtagRemove User From Org

Get All Users

Add User

Update Org Level Permissions

Delete User

Get User Roles

Get User By ID

Update User by userID

Remove User From Org